Priority Two

{"class":["gateway"],"properties":{"name":"Easegress","provider":"Easegress","slug":"easegress","rating":2,"license":"Proprietary, Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2022-11","description":"Easegress is a Cloud Native traffic orchestration system designed for High Availability -  Built-in Raft consensus & leader election provides 99.99% availability. Traffic Orchestration -  Simple orchestration of various filters for each traffic pipeline. High Performance -  Lightweight and essential features speed up the performance. Observability -  There are many meaningful statistics periodically in a readable way. Extensibility -  It's easy to develop your own filter or controller with high-level programming language. Integration -  The simple interfaces make it easy to integrate with other systems, such as Kubernetes, Ingress, EaseMesh sidecar, Workflow, etc.\n","platformCapabilities":["Gateway","Analytics","Monitoring"],"gatewayCapabilities":["Custom Code Execution","Mediation","Protocol Transformation","Traffic Management","Versioning"],"customCodeSupport":["None"],"upstreamProtocols":["HTTP/1.1","HTTP/2","HTTP/2.0","HTTP/3(QUIC)","MQTT","WebSockets"],"downstreamProtocols":["HTTP/1.1","HTTP/2","HTTP/2.0","HTTP/3(QUIC)","MQTT","WebSockets"],"deliveryModels":["SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Cache Eviction","Cache Invalidation","Cache Lookup","Cache Population","Cache Storage","Cache Target Response","Cache Validation","Canary Release","Compression","Circuit Breaker","Conditional Routing","Content-Based Routing","Distributed Tracing","Dynamic Routing","Load Balancer Routing","Quota","Quota Reset","Rate Limiting","Rate Limiting (Dynamic)","Request Size Limiting","Service Discovery","Throttling","Traffic Optimization"]},{"category":"Mediation","capabilities":["Aggregation","Adaption","CORS","Cache Eviction","Cache Lookup","Cache Store","Custom Exception Handling","Hot-Update","Ingress Control","JSON Validation","Request Size Limit","Request Termination","Request Transformation","Response Transformation","Routing Rules","Retries","URL Rewriting","XML to JSON"]},{"category":"Security","capabilities":["API Key","API Key Authentication","Access Control Lists (ACL)","Audit Logs","Basic Authentication","CORS","IP Access Rules","JWT","JWT Validation","JWT authorizers","Let's Encrypt","Message Inspection","Mutual TLS","OAuth 1.0","OAuth 2.0","Okta","OpenID Connect","Signatures","SAML Assertion"]},{"category":"Extensions","capabilities":["HTTP Callout","HTTP integrations","Plugins","Side-Car","Knative FaaS","Consul","Etcd","Nacos"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://megaease.com/easegress/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://megaease.com/easegress/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/name.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/easegress.png"}]}

Easegress

Easegress is a Cloud Native traffic orchestration system designed for High Availability - Built-in Raft consensus & leader election provides 99.99% availability. Traffic Orchestration - Simple orchestration of various filters for each traffic pipeline. High Performance - Lightweight and essential features speed up the performance. Observability - There are many meaningful statistics periodically in a readable way. Extensibility - It's easy to develop your own filter or controller with high-level programming language. Integration - The simple interfaces make it easy to integrate with other systems, such as Kubernetes, Ingress, EaseMesh sidecar, Workflow, etc.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Gateway
Analytics
Monitoring

Gateway Capabilities

These are the capabilities the gateway supports.

Custom Code Execution
Mediation
Protocol Transformation
Traffic Management
Versioning

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1
HTTP/2
HTTP/2.0
HTTP/3(QUIC)
MQTT
WebSockets

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1
HTTP/2
HTTP/2.0
HTTP/3(QUIC)
MQTT
WebSockets

Custom Code

If they offer plugin, extension, and custom coding options.

None

Delivery Models

These are they ways you can deliver this solution.

SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

Cache Eviction
Cache Invalidation
Cache Lookup
Cache Population
Cache Storage
Cache Target Response
Cache Validation
Canary Release
Compression
Circuit Breaker
Conditional Routing
Content-Based Routing
Distributed Tracing
Dynamic Routing
Load Balancer Routing
Quota
Quota Reset
Rate Limiting
Rate Limiting (Dynamic)
Request Size Limiting
Service Discovery
Throttling
Traffic Optimization

Mediation

Aggregation
Adaption
CORS
Cache Eviction
Cache Lookup
Cache Store
Custom Exception Handling
Hot-Update
Ingress Control
JSON Validation
Request Size Limit
Request Termination
Request Transformation
Response Transformation
Routing Rules
Retries
URL Rewriting
XML to JSON

Security

API Key
API Key Authentication
Access Control Lists (ACL)
Audit Logs
Basic Authentication
CORS
IP Access Rules
JWT
JWT Validation
JWT authorizers
Let's Encrypt
Message Inspection
Mutual TLS
OAuth 1.0
OAuth 2.0
Okta
OpenID Connect
Signatures
SAML Assertion

Extensions

HTTP Callout
HTTP integrations
Plugins
Side-Car
Knative FaaS
Consul
Etcd
Nacos

API Resources

No API Resources

(Product) (Docs)

{"class":["gateway"],"properties":{"name":"EnRoute","provider":"EnRoute","slug":"enroute","rating":2,"license":"Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2022-11","description":"EnRoute makes is simple to expose services running in Kubernetes using one helm command. L7 policy can be specified using simple switches to enable/disable functionality.\n","platformCapabilities":["Gateway","Analytics","Portal","Documentation"],"gatewayCapabilities":["Mediation","Protocol Transformation","Traffic Management","Versioning"],"customCodeSupport":["WASM","Lua"],"upstreamProtocols":["HTTP/1.1","GraphQL","WebSockets"],"downstreamProtocols":["HTTP/1.1","GraphQL","WebSockets"],"deliveryModels":["SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Health Checks","Cache Eviction","Cache Invalidation","Cache Lookup","Cache Population","Cache Storage","Cache Target Response","Cache Validation","Canary Release","Circuit Breaker","Edge","Kubernetes Ingress","Quota","Quota Reset","Rate Limiting","Request Size Limiting","Telemetry","Throttling"]},{"category":"Mediation","capabilities":["CORS","Custom Resource Definitions","Request Size Limit","Request Termination","Request Transformation","Response Transformation","URL Rewriting"]},{"category":"Security","capabilities":["API Key","API Key Authentication","Access Control Lists (ACL)","Audit Logs","Basic Authentication","CORS","HashiCorp Vault Authentication","IP Access Rules","JWT","JWT Validation","JWT authorizers","Mutual TLS","OAuth 1.0","OAuth 2.0","OpenID Connect"]},{"category":"Extensions","capabilities":["AWS Lambda","HTTP Callout","HTTP integrations","Open Policy Agent","Plugins","Envoy Proxy"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://getenroute.io/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://getenroute.io/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/name.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/enroute.png"}]}

EnRoute

EnRoute makes is simple to expose services running in Kubernetes using one helm command. L7 policy can be specified using simple switches to enable/disable functionality.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Gateway
Analytics
Portal
Documentation

Gateway Capabilities

These are the capabilities the gateway supports.

Mediation
Protocol Transformation
Traffic Management
Versioning

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1
GraphQL
WebSockets

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1
GraphQL
WebSockets

Custom Code

If they offer plugin, extension, and custom coding options.

WASM
Lua

Delivery Models

These are they ways you can deliver this solution.

SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

Health Checks
Cache Eviction
Cache Invalidation
Cache Lookup
Cache Population
Cache Storage
Cache Target Response
Cache Validation
Canary Release
Circuit Breaker
Edge
Kubernetes Ingress
Quota
Quota Reset
Rate Limiting
Request Size Limiting
Telemetry
Throttling

Mediation

CORS
Custom Resource Definitions
Request Size Limit
Request Termination
Request Transformation
Response Transformation
URL Rewriting

Security

API Key
API Key Authentication
Access Control Lists (ACL)
Audit Logs
Basic Authentication
CORS
HashiCorp Vault Authentication
IP Access Rules
JWT
JWT Validation
JWT authorizers
Mutual TLS
OAuth 1.0
OAuth 2.0
OpenID Connect

Extensions

AWS Lambda
HTTP Callout
HTTP integrations
Open Policy Agent
Plugins
Envoy Proxy

API Resources

No API Resources

(Product) (Docs)

{"class":["gateway"],"properties":{"name":"Envoy","provider":"Envoy","slug":"envoy","rating":2,"license":"Proprietary, Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2022-11","description":"Originally built at Lyft, Envoy is a high performance C++ distributed proxy designed for single services and applications, as well as a communication bus and “universal data plane” designed for large microservice “service mesh” architectures. Built on the learnings of solutions such as NGINX, HAProxy, hardware load balancers, and cloud load balancers, Envoy runs alongside every application and abstracts the network by providing common features in a platform-agnostic manner.\n","platformCapabilities":["Gateway"],"gatewayCapabilities":["Mediation","Traffic Management","Versioning"],"customCodeSupport":["None"],"upstreamProtocols":["HTTP/1.1"],"downstreamProtocols":["HTTP/1.1"],"deliveryModels":["Customer Managed (Cloud)","Customer Managed (On-Premises)","Hybrid"],"policies":[{"category":"Traffic Management","capabilities":["Cache Eviction","Cache Invalidation","Cache Lookup","Cache Population","Cache Storage","Cache Target Response","Cache Validation","Circuit Breaker","Conditional Routing","Content-Based Routing","Load Balancer Routing","Quota","Quota Reset","Rate Limiting","Request Size Limiting","Service Discovery","Throttling","Traffic Optimization"]},{"category":"Mediation","capabilities":["CORS","Cache Eviction","Cache Lookup","Cache Store","Request Size Limit","Request Termination","Request Transformation","Response Transformation","URL Rewriting"]},{"category":"Security","capabilities":["API Key","API Key Authentication","Access Control Lists","Audit Logs","Basic Authentication","CORS","IP Access Rules","JWT","JWT Validation","JWT authorizers","Let's Encrypt","Message Inspection","Mutual TLS","OAuth 1.0","OAuth 2.0","OpenID Connect"]},{"category":"Extensions","capabilities":["HTTP Callout","HTTP integrations","Kubernetes Ingress"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://gateway.envoyproxy.io/v0.2.0/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://github.com/envoyproxy/gateway"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/envoy.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/envoy.png"}]}

Envoy

Originally built at Lyft, Envoy is a high performance C++ distributed proxy designed for single services and applications, as well as a communication bus and “universal data plane” designed for large microservice “service mesh” architectures. Built on the learnings of solutions such as NGINX, HAProxy, hardware load balancers, and cloud load balancers, Envoy runs alongside every application and abstracts the network by providing common features in a platform-agnostic manner.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Gateway

Gateway Capabilities

These are the capabilities the gateway supports.

Mediation
Traffic Management
Versioning

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1

Custom Code

If they offer plugin, extension, and custom coding options.

None

Delivery Models

These are they ways you can deliver this solution.

Customer Managed (Cloud)
Customer Managed (On-Premises)
Hybrid

Policies

These are the policies available across the gateway capabilities.

Traffic Management

Cache Eviction
Cache Invalidation
Cache Lookup
Cache Population
Cache Storage
Cache Target Response
Cache Validation
Circuit Breaker
Conditional Routing
Content-Based Routing
Load Balancer Routing
Quota
Quota Reset
Rate Limiting
Request Size Limiting
Service Discovery
Throttling
Traffic Optimization

Mediation

CORS
Cache Eviction
Cache Lookup
Cache Store
Request Size Limit
Request Termination
Request Transformation
Response Transformation
URL Rewriting

Security

API Key
API Key Authentication
Access Control Lists
Audit Logs
Basic Authentication
CORS
IP Access Rules
JWT
JWT Validation
JWT authorizers
Let's Encrypt
Message Inspection
Mutual TLS
OAuth 1.0
OAuth 2.0
OpenID Connect

Extensions

HTTP Callout
HTTP integrations
Kubernetes Ingress

API Resources

No API Resources

(Product) (Docs)

{"class":["gateway"],"properties":{"name":"Gravitee","provider":"Gravitee","slug":"gravitee","rating":2,"license":"Proprietary, Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2022-11","description":"Manage, secure, and govern synchronous and asynchronous APIs with the world's first-ever event-native API Management platform.\n","platformCapabilities":["Design","Gateway","Analytics","Dashboards","Portal","Documentation"],"gatewayCapabilities":["Mediation","Mocking","OpenAPI Integration","OpenAPI Enforcement","Protocol Transformation","Traffic Management","Versioning"],"customCodeSupport":["None"],"upstreamProtocols":["HTTP/1.1","HTTP/2","HTTP/2.0","GraphQL","Kafka","WebSockets","gRPC","RabbitMQ"],"downstreamProtocols":["HTTP/1.1","HTTP/2","HTTP/2.0","GraphQL","Kafka","WebSockets","gRPC","RabbitMQ"],"deliveryModels":["Customer Managed (Cloud)","Customer Managed (On-Premises)","Hybrid","SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Load Balancer Routing","Failover","Quota","Quota Reset","Rate Limiting","Request Size Limiting","Service Discovery","Throttling","Traffic Optimization"]},{"category":"Mediation","capabilities":["CORS","Request Size Limit","Request Termination","Request Transformation","Response Transformation","Response Templates","URL Rewriting"]},{"category":"Security","capabilities":["API Key","API Key Authentication","Access Control Lists (ACL)","Audit Logs","Basic Authentication","CORS","IP Access Rules","Mutual TLS","OAuth 1.0","OAuth 2.0","OpenID Connect"]},{"category":"Extensions","capabilities":["HTTP Callout","HTTP integrations","Command Line Interface (CLI)","Grafana","Cabana"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://www.gravitee.io/platform/api-management"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://www.gravitee.io/platform/api-management"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/name.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/gravitee.png"}]}

Gravitee

Manage, secure, and govern synchronous and asynchronous APIs with the world's first-ever event-native API Management platform.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Design
Gateway
Analytics
Dashboards
Portal
Documentation

Gateway Capabilities

These are the capabilities the gateway supports.

Mediation
Mocking
OpenAPI Integration
OpenAPI Enforcement
Protocol Transformation
Traffic Management
Versioning

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1
HTTP/2
HTTP/2.0
GraphQL
Kafka
WebSockets
gRPC
RabbitMQ

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1
HTTP/2
HTTP/2.0
GraphQL
Kafka
WebSockets
gRPC
RabbitMQ

Custom Code

If they offer plugin, extension, and custom coding options.

None

Delivery Models

These are they ways you can deliver this solution.

Customer Managed (Cloud)
Customer Managed (On-Premises)
Hybrid
SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

Load Balancer Routing
Failover
Quota
Quota Reset
Rate Limiting
Request Size Limiting
Service Discovery
Throttling
Traffic Optimization

Mediation

CORS
Request Size Limit
Request Termination
Request Transformation
Response Transformation
Response Templates
URL Rewriting

Security

API Key
API Key Authentication
Access Control Lists (ACL)
Audit Logs
Basic Authentication
CORS
IP Access Rules
Mutual TLS
OAuth 1.0
OAuth 2.0
OpenID Connect

Extensions

HTTP Callout
HTTP integrations
Command Line Interface (CLI)
Grafana
Cabana

API Resources

Gravitee.io - Management API OpenAPI	{"openapi":"3.0.1","info":{"title":"Gravitee.io - Management API","description":"Some news resources are in alpha version. This implies that they are likely to be modified or even removed in future versions. They are marked with the 🧪 symbol","version":"3.19.0"},"servers":[{"url":"http://localhost:8083/management"}],"security":[{"gravitee-auth":[]}],"tags":[{"name":"API Alerts"},{"name":"API Analytics"},{"name":"API Audits"},{"name":"API Definition"},{"name":"API Events"},{"name":"API Health"},{"name":"API Keys"},{"name":"API Logs"},{"name":"API Media"},{"name":"API Memberships"},{"name":"API Metadata"},{"name":"API Notifications"},{"name":"API Pages"},{"name":"API Plans"},{"name":"API Quality"},{"name":"API Ratings"},{"name":"API Subscriptions"},{"name":"APIs"},{"name":"Alerts"},{"name":"Application Alerts"},{"name":"Application Analytics"},{"name":"Application Logs"},{"name":"Application Memberships"},{"name":"Application Metadata"},{"name":"Application Notifications"},{"name":"Application Subscriptions"},{"name":"Applications"},{"name":"Audit"},{"name":"Authentication"},{"name":"Categories"},{"name":"Client Registration Providers"},{"name":"Configuration"},{"name":"Console"},{"name":"Current User"},{"name":"Custom User Fields"},{"name":"Dashboards"},{"name":"Dictionaries"},{"name":"Entrypoints"},{"name":"Environment"},{"name":"Environment Analytics"},{"name":"Flows"},{"name":"Gateway"},{"name":"Group Invitations"},{"name":"Group Memberships"},{"name":"Groups"},{"name":"Identity Providers"},{"name":"Messages"},{"name":"Metadata"},{"name":"Newsletter"},{"name":"Notifications"},{"name":"Organization"},{"name":"Organization Groups"},{"name":"Plans"},{"name":"Platform"},{"name":"Platform Alerts"},{"name":"Platform Analytics"},{"name":"Platform Events"},{"name":"Platform Logs"},{"name":"Platform Tickets"},{"name":"Plugins"},{"name":"Portal"},{"name":"Portal APIs"},{"name":"Portal Media"},{"name":"Portal Notifications"},{"name":"Portal Pages"},{"name":"Portal entrypoints"},{"name":"Promotion"},{"name":"Promotions"},{"name":"Roles"},{"name":"Settings"},{"name":"Sharding Tags"},{"name":"Subscription"},{"name":"Tenants"},{"name":"Themes"},{"name":"Top APIs"},{"name":"User Notifications"},{"name":"User Registration"},{"name":"User Tokens"},{"name":"Users"},{"name":"🧪 V4 - API Plans"},{"name":"🧪 V4 - APIs"},{"name":"🧪 V4 - Plugins"}],"paths":{"/auth/cockpit":{"get":{"operationId":"tokenExchange","parameters":[{"name":"token","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}":{"get":{"tags":["Organization"],"summary":"GET organization","operationId":"get","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Organization"],"summary":"Update organization","operationId":"update","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrganizationEntity"}}}},"responses":{"204":{"description":"Organization successfully updated"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/audit":{"get":{"tags":["Audit"],"summary":"Retrieve audit logs for the environment","description":"User must have the ENVIRONMENT_AUDIT[READ] or ORGANIZATION_AUDIT[READ] permission to use this service","operationId":"getAudits","parameters":[{"name":"environment","in":"query","schema":{"type":"string"}},{"name":"api","in":"query","schema":{"type":"string"}},{"name":"application","in":"query","schema":{"type":"string"}},{"name":"type","in":"query","description":"filter on the type of audit","schema":{"$ref":"#/components/schemas/AuditType"}},{"name":"event","in":"query","description":"filter by the name of an event.","schema":{"type":"string"},"example":"APPLICATION_UPDATED, API_CREATED, METADATA_DELETED, ..."},{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"size","in":"query","description":"Number of elements per page","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditEntityMetadataPage"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/audit/events":{"get":{"tags":["Audit"],"summary":"List available audit event type for the environment","description":"User must have the ENVIRONMENT_AUDIT[READ] or ORGANIZATION_AUDIT[READ] permission to use this service","operationId":"getAuditEvents","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of audits","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditEvent"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/auth/oauth2/{identity}":{"post":{"tags":["Authentication"],"operationId":"exchangeAuthorizationCode_1","parameters":[{"name":"identity","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/Payload"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/auth/oauth2/{identity}/exchange":{"post":{"tags":["Authentication"],"operationId":"tokenExchange_2","parameters":[{"name":"identity","in":"path","required":true,"schema":{"type":"string"}},{"name":"token","in":"query","schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/configuration/custom-user-fields":{"get":{"tags":["Custom User Fields","Configuration"],"summary":"List All Custom User Fields","description":"User must have the CUSTOM_USER_FIELDS[READ] permission to use this service","operationId":"getCustomUserFields","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Custom User Field deleted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomUserFieldEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Custom User Fields","Configuration"],"summary":"Create a Custom User Field","description":"User must have the CUSTOM_USER_FIELDS[CREATE] permission to use this service","operationId":"createCustomUserField","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUserFieldEntity"}}}},"responses":{"201":{"description":"Custom User Field Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUserFieldEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/custom-user-fields/{key}":{"put":{"tags":["Custom User Fields","Configuration"],"summary":"Update a Custom User Field","description":"User must have the CUSTOM_USER_FIELDS[UPDATE] permission to use this service","operationId":"updateCustomUserField","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUserFieldEntity"}}}},"responses":{"200":{"description":"Custom User Field updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUserFieldEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Custom User Fields","Configuration"],"summary":"Delete a Custom User Field","description":"User must have the CUSTOM_USER_FIELDS[DELETE] permission to use this service","operationId":"deleteCustomUserField","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Custom User Field deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/entrypoints":{"get":{"tags":["Entrypoints","Configuration"],"summary":"List the platform entrypoints","description":"User must have the MANAGEMENT_ENTRYPOINT[READ] permission to use this service","operationId":"getEntrypoints","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of platform entrypoints","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntrypointEntity"}}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Entrypoints","Configuration"],"summary":"Update a platform entrypoint","description":"User must have the MANAGEMENT_ENTRYPOINT[UPDATE] permission to use this service","operationId":"updateEntrypoint","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEntryPointEntity"}}},"required":true},"responses":{"200":{"description":"Updated entrypoint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntrypointEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Entrypoints","Configuration"],"summary":"Create a platform entrypoint","description":"User must have the MANAGEMENT_ENTRYPOINT[CREATE] permission to use this service","operationId":"createEntrypoint","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewEntryPointEntity"}}},"required":true},"responses":{"201":{"description":"Entrypoint successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntrypointEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/entrypoints/{entrypoint}":{"get":{"tags":["Entrypoints","Configuration"],"summary":"Get a platform entrypoints","description":"User must have the MANAGEMENT_ENTRYPOINT[READ] permission to use this service","operationId":"getEntrypoint","parameters":[{"name":"entrypoint","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A platform entrypoint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntrypointEntity"}}}},"404":{"description":"Entrypoint not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Entrypoints","Configuration"],"summary":"Delete a platform entrypoint","description":"User must have the MANAGEMENT_ENTRYPOINT[DELETE] permission to use this service","operationId":"deleteEntrypoint","parameters":[{"name":"entrypoint","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Entrrypoint successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/flows":{"get":{"tags":["Flows","Configuration"],"summary":"Get the global flow configuration of the organization","operationId":"hasPolicies","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Platform flows configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationFlowConfiguration"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/flows/configuration-schema":{"get":{"tags":["Flows","Configuration"],"operationId":"getConfigurationSchemaForm","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/configuration/flows/flow-schema":{"get":{"tags":["Flows","Configuration"],"operationId":"getPlatformFlowSchemaForm","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/configuration/identities":{"get":{"tags":["Configuration","Identity Providers"],"summary":"Get the list of identity providers","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[READ] permission to use this service","operationId":"getIdentityProviders","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List identity providers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProviderListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Configuration","Identity Providers"],"summary":"Create an identity provider","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[CREATE] permission to use this service","operationId":"createIdentityProvider","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewIdentityProviderEntity"}}},"required":true},"responses":{"201":{"description":"Identity provider successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/identities/{identityProvider}":{"get":{"tags":["Configuration","Identity Providers"],"summary":"Get an identity provider","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[READ] permission to use this service","operationId":"getIdentityProvider","parameters":[{"name":"identityProvider","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"An identity provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Configuration","Identity Providers"],"summary":"Update an identity provider","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[UPDATE] permission to use this service","operationId":"updateIdentityProvider","parameters":[{"name":"identityProvider","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIdentityProviderEntity"}}},"required":true},"responses":{"200":{"description":"Updated identity provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Configuration","Identity Providers"],"summary":"Delete an identity provider","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[DELETE] permission to use this service","operationId":"deleteIdentityProvider","parameters":[{"name":"identityProvider","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Identity provider successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/notification-templates":{"get":{"tags":["Notifications","Configuration"],"summary":"List all notification templates.","description":"User must have the NOTIFICATION_TEMPLATES[READ] permission to use this service","operationId":"getNotificationTemplates","parameters":[{"name":"scope","in":"query","description":"filter by notification scope","schema":{"type":"string"}},{"name":"hook","in":"query","description":"filter by notification hook","schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Notifications templates","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotificationTemplateEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Notifications","Configuration"],"summary":"Create a notification template","description":"User must have the NOTIFICATION_TEMPLATES[CREATE] permission to use this service","operationId":"createNotificationTemplate","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationTemplateEntity"}}}},"responses":{"200":{"description":"Created notification template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationTemplateEntity"}}}},"400":{"description":"There must not be any ID in the payload"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/notification-templates/{notificationTemplateId}":{"get":{"tags":["Notifications","Configuration"],"summary":"Get a specific notification template.","description":"User must have the NOTIFICATION_TEMPLATES[READ] permission to use this service","operationId":"getNotificationTemplate","parameters":[{"name":"notificationTemplateId","in":"path","description":"ID of the notification template","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Notification template found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationTemplateEntity"}}}},"404":{"description":"Notification template not found"},"500":{"description":"Internal server error"}}},"put":{"tags":["Notifications","Configuration"],"summary":"Update an existing notification template","description":"User must have the NOTIFICATION_TEMPLATES[UPDATE] permission to use this service","operationId":"updateNotificationTemplate","parameters":[{"name":"notificationTemplateId","in":"path","description":"ID of the notification template","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationTemplateEntity"}}}},"responses":{"200":{"description":"Updated notification template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationTemplateEntity"}}}},"400":{"description":"ID in path parameter is not the same as in the payload"},"404":{"description":"Notification template not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/rolescopes":{"get":{"tags":["Roles","Configuration"],"summary":"List availables role scopes","operationId":"getRoleScopes","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of role scopes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleScopesLinkedHashMap"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/rolescopes/{scope}/roles":{"get":{"tags":["Roles","Configuration"],"summary":"List of roles","description":"User must have the MANAGEMENT_ROLE[READ] permission to use this service","operationId":"getRoles","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Role successfully removed","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RoleEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Roles","Configuration"],"summary":"Create a role","description":"User must have the MANAGEMENT_ROLE[CREATE] permission to use this service","operationId":"createRole","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewRoleEntity"}}},"required":true},"responses":{"200":{"description":"Role successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/rolescopes/{scope}/roles/{role}":{"get":{"tags":["Roles","Configuration"],"summary":"Get a role","description":"User must have the MANAGEMENT_ROLE[READ] permission to use this service","operationId":"getRole","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleEntity"}}}},"404":{"description":"Role not found"},"500":{"description":"Internal server error"}}},"put":{"tags":["Roles","Configuration"],"summary":"Update a role","description":"User must have the MANAGEMENT_ROLE[UPDATE] permission to use this service","operationId":"updateRole","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRoleEntity"}}},"required":true},"responses":{"200":{"description":"Role successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleEntity"}}}},"404":{"description":"Role not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Roles","Configuration"],"summary":"Delete a role","description":"User must have the MANAGEMENT_ROLE[DELETE] permission to use this service","operationId":"deleteRole","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Role successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleEntity"}}}},"404":{"description":"Role not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/rolescopes/{scope}/roles/{role}/users":{"get":{"tags":["Roles","Configuration"],"summary":"List users with the given role","description":"User must have the MANAGEMENT_ROLE[READ] permission to use this service","operationId":"getUsersPerRole","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"List of user's memberships","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MembershipListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Roles","Configuration"],"summary":"Add or update a role for a user","description":"User must have the MANAGEMENT_ROLE[CREATE] and MANAGEMENT_ROLE[UPDATE] permission to use this service","operationId":"addRoleToUser","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleMembership"}}},"required":true},"responses":{"201":{"description":"Membership successfully created / updated"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/rolescopes/{scope}/roles/{role}/users/{userId}":{"delete":{"tags":["Roles","Configuration"],"summary":"Delete the role for a given user","description":"User must have the MANAGEMENT_ROLE[DELETE] permission to use this service","operationId":"deleteRoleForUser","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Role successfully removed"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/tags":{"get":{"tags":["Sharding Tags","Configuration"],"summary":"List sharding tags","operationId":"getTags","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of sharding tags","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TagEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Sharding Tags","Configuration"],"summary":"Create a sharding tag","description":"User must have the MANAGEMENT_TAG[CREATE] permission to use this service","operationId":"createTag","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTagEntity"}}},"required":true},"responses":{"201":{"description":"A new sharding tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/tags/{tag}":{"get":{"tags":["Sharding Tags","Configuration"],"summary":"Get a sharding tag","description":"User must have the MANAGEMENT_TAG[READ] permission to use this service","operationId":"getTag","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Sharding Tags","Configuration"],"summary":"Update an existing sharding tag","description":"User must have the MANAGEMENT_TAG[UPDATE] permission to use this service","operationId":"updateTag","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTagEntity"}}},"required":true},"responses":{"200":{"description":"Sharding tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Sharding Tags","Configuration"],"summary":"Delete an existing sharding tag","description":"User must have the MANAGEMENT_TAG[DELETE] permission to use this service","operationId":"deleteTag","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Sharding tag successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/tenants":{"get":{"tags":["Tenants","Configuration"],"summary":"List tenants","operationId":"getTenants","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of tenants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantEntity"}}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Tenants","Configuration"],"summary":"Update a tenant","description":"User must have the MANAGEMENT_TENANT[UPDATE] permission to use this service","operationId":"updateTenants","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateTenantEntity"}}}},"required":true},"responses":{"200":{"description":"List of tenants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Tenants","Configuration"],"summary":"Create a tenant","description":"User must have the MANAGEMENT_TENANT[CREATE] permission to use this service","operationId":"createTenants","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewTenantEntity"}}}},"required":true},"responses":{"200":{"description":"List of tenants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/configuration/tenants/{tenant}":{"delete":{"tags":["Tenants","Configuration"],"summary":"Delete a tenant","description":"User must have the MANAGEMENT_TENANT[DELETE] permission to use this service","operationId":"deleteTenant","parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of tenants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/console":{"get":{"tags":["Console"],"summary":"Get the console configuration needed for runtime","description":"Every users can use this service","operationId":"getConsoleConfig","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Console configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsoleConfigEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Console"],"summary":"Save the console configuration","operationId":"saveConsoleConfig","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsoleSettingsEntity"}}},"required":true},"responses":{"200":{"description":"Console configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsoleSettingsEntity"}}}},"500":{"description":"Internal server error"}},"deprecated":true}},"/organizations/{orgId}/environments":{"get":{"summary":"List available environments for current user organization","operationId":"getEnvironments","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentEntity"}}}}}}}},"/organizations/{orgId}/environments/permissions":{"get":{"summary":"List available environments with their permissions for current user organization","operationId":"getEnvironmentsPermissions","parameters":[{"name":"idOrHrid","in":"query","description":"To filter on environment id or hrid","schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Current user permissions on its environments","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentPermissionsEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}":{"get":{"tags":["Environment"],"summary":"Get an Environment","operationId":"getEnvironment","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Found Environment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/alerts/metrics":{"get":{"tags":["Alerts"],"summary":"List alert metrics","operationId":"getAlertMetrics","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertMetric"}}}}}}}},"/organizations/{orgId}/environments/{envId}/analytics":{"get":{"tags":["Environment Analytics"],"summary":"Get environment analytics","operationId":"getPlatformAnalytics","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"interval","in":"query","description":"The time interval when getting histogram data (in milliseconds)","schema":{"type":"integer","format":"int64"},"example":600000},{"name":"query","in":"query","description":"The Lucene query used to filter data","schema":{"type":"string"},"example":"api:xxxx-xxxx-xxxx-xxxx AND plan:yyyy-yyyy-yyyy-yyyy AND host:\"demo.gravitee.io\" AND path:/test"},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32"}},{"name":"type","in":"query","description":"The type of data to retrieve","required":true,"schema":{"$ref":"#/components/schemas/AnalyticsType"}},{"name":"ranges","in":"query","description":"Ranges allows you to group field's data. Mainly used to group HTTP statuses code with `group_by` queries","explode":false,"schema":{"type":"array","items":{"type":"string"}},"example":"100:199,200:299,300:399,400:499,500:599"},{"name":"aggs","in":"query","description":"Aggregations are used when doing `date_histo` queries and allows you to group field's data. Mainly used to group HTTP statuses code","explode":false,"schema":{"type":"array","items":{"type":"string"}},"example":"avg:response-time,avg:api-response-time"},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Environment analytics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Analytics"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis":{"get":{"tags":["APIs"],"summary":"List APIs","description":"List all the APIs accessible to the current user.","operationId":"getApis","parameters":[{"name":"category","in":"query","description":"filter by category id","schema":{"type":"string"}},{"name":"group","in":"query","description":"filter by group id","schema":{"type":"string"}},{"name":"top","in":"query","description":"true if you only want Top APIs. default: false","schema":{"type":"boolean"}},{"name":"context-path","in":"query","description":"filter by context path","schema":{"type":"string"}},{"name":"label","in":"query","description":"filter by label","schema":{"type":"string"}},{"name":"state","in":"query","description":"filter by state: STARTED or STOPPED","schema":{"type":"string"}},{"name":"visibility","in":"query","description":"filter by visibility: PUBLIC or PRIVATE","schema":{"type":"string"}},{"name":"version","in":"query","description":"filter by version","schema":{"type":"string"}},{"name":"executionMode","in":"query","description":"filter by execution mode","schema":{"type":"string","enum":["V3","JUPITER"]}},{"name":"name","in":"query","description":"filter by full API Name","schema":{"type":"string"}},{"name":"tag","in":"query","description":"filter by tag","schema":{"type":"string"}},{"name":"portal","in":"query","schema":{"type":"boolean"}},{"name":"crossId","in":"query","description":"filter by crossId","schema":{"type":"string"}},{"name":"ids","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List accessible APIs for current user","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["APIs"],"summary":"Create an API","description":"User must have API_PUBLISHER or ADMIN role to create an API.","operationId":"createApi","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApiEntity"}}},"required":true},"responses":{"201":{"description":"API successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/_paged":{"get":{"tags":["APIs"],"summary":"List APIs with pagination","description":"List all the APIs accessible to the current user with pagination.","operationId":"getApisPaged","parameters":[{"name":"category","in":"query","description":"filter by category id","schema":{"type":"string"}},{"name":"group","in":"query","description":"filter by group id","schema":{"type":"string"}},{"name":"top","in":"query","description":"true if you only want Top APIs. default: false","schema":{"type":"boolean"}},{"name":"context-path","in":"query","description":"filter by context path","schema":{"type":"string"}},{"name":"label","in":"query","description":"filter by label","schema":{"type":"string"}},{"name":"state","in":"query","description":"filter by state: STARTED or STOPPED","schema":{"type":"string"}},{"name":"visibility","in":"query","description":"filter by visibility: PUBLIC or PRIVATE","schema":{"type":"string"}},{"name":"version","in":"query","description":"filter by version","schema":{"type":"string"}},{"name":"executionMode","in":"query","description":"filter by execution mode","schema":{"type":"string","enum":["V3","JUPITER"]}},{"name":"name","in":"query","description":"filter by full API Name","schema":{"type":"string"}},{"name":"tag","in":"query","description":"filter by tag","schema":{"type":"string"}},{"name":"portal","in":"query","schema":{"type":"boolean"}},{"name":"crossId","in":"query","description":"filter by crossId","schema":{"type":"string"}},{"name":"ids","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Page of APIs for current user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiListItemPagedResult"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/_search":{"post":{"tags":["APIs"],"summary":"Search for API using the search engine","operationId":"searchApis","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List accessible APIs for current user","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/_search/_paged":{"post":{"tags":["APIs"],"summary":"Search for API using the search engine","operationId":"searchPagedApis","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"}},{"name":"order","in":"query","schema":{"type":"string","description":"By default, sort is ASC. If field starts with '-', the order sort is DESC. Currently, only name and paths are supported","default":"name"}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List accessible APIs for current user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiListItem"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/hooks":{"get":{"tags":["APIs"],"summary":"Get the list of available hooks","operationId":"getApiHooks","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Hook"}}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/import":{"put":{"tags":["APIs"],"summary":"Update the API from the API definition","description":"Update the API from the API definition in JSON format either with json or via an URL","operationId":"updateWithDefinition","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"API successfully updated from API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}}},"post":{"tags":["APIs"],"summary":"Create an API by importing an API definition","description":"Create an API by importing an existing API definition in JSON format.","operationId":"importApiDefinition","parameters":[{"name":"definitionVersion","in":"query","schema":{"type":"string","default":"1.0.0"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}},"required":true},"responses":{"200":{"description":"API successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/import-url":{"post":{"tags":["APIs"],"summary":"Create an API by importing a URL pointing to an API definition","description":"Create an API by importing an existing API definition via a URL","operationId":"importApiDefinitionUrl","parameters":[{"name":"definitionVersion","in":"query","schema":{"type":"string","default":"1.0.0"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"API successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/import/swagger":{"post":{"tags":["APIs"],"summary":"Create an API definition from a Swagger descriptor","operationId":"importSwaggerApi","parameters":[{"name":"definitionVersion","in":"query","schema":{"type":"string","default":"1.0.0"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ImportSwaggerDescriptorEntity"}}},"required":true},"responses":{"201":{"description":"API definition from Swagger descriptor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/schema":{"get":{"tags":["APIs"],"summary":"Get the API configuration schema","operationId":"getApiFlowSchemaForm","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/verify":{"post":{"tags":["APIs"],"summary":"Check if an API match the following criteria","operationId":"verifyApi","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyApiParam"}}}},"responses":{"200":{"description":"No API match the following criteria","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"API already exist with the following criteria"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}":{"get":{"tags":["APIs"],"summary":"Get the API","description":"User must have the READ permission on the API_DEFINITION to use this service on a private API.","operationId":"getApi","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["APIs"],"summary":"Update the API","description":"User must have the MANAGE_API permission to use this service","operationId":"updateApi","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiEntity"}}},"required":true},"responses":{"200":{"description":"API successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["APIs"],"summary":"Manage the API's lifecycle","description":"User must have the MANAGE_LIFECYCLE permission to use this service","operationId":"doApiLifecycleAction","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LifecycleAction"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"500":{"description":"Internal server error"}}},"delete":{"tags":["APIs"],"summary":"Delete the API","description":"User must have the DELETE permission to use this service","operationId":"deleteApi","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"closePlans","in":"query","schema":{"type":"boolean"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"API successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/_debug":{"post":{"tags":["APIs"],"summary":"Debug an API on gateway instances","description":"User must have the UPDATE permission on API_DEFINITION to use this service","operationId":"debugAPI","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/DebugApiEntity"}}}},"responses":{"200":{"description":"Debug session successfully started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/_migrate":{"post":{"tags":["APIs"],"summary":"Migrate the API definition to be used with Policy Studio","description":"User must have the MANAGE_API create permission to use this service","operationId":"migrateAPI","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/_promote":{"post":{"tags":["APIs"],"summary":"Promote the API to another environment","description":"User must have the API_DEFINITION update permission to use this service","operationId":"promoteAPI","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/PromotionRequestEntity"}}},"required":true},"responses":{"200":{"description":"Promotion request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/alerts":{"get":{"tags":["API Alerts","APIs"],"summary":"List alerts of an API","description":"User must have the API_ALERT[READ] permission to use this service","operationId":"getApiAlerts","parameters":[{"name":"event_counts","in":"query","schema":{"type":"boolean","default":true}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of alerts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Alerts","APIs"],"summary":"Create an alert for an API","description":"User must have the API_ALERT[CREATE] permission to use this service","operationId":"createApiAlert","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewAlertTriggerEntity"}}},"required":true},"responses":{"200":{"description":"Alert successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/alerts/analytics":{"get":{"tags":["API Alerts","APIs"],"summary":"List configured alerts of the API","description":"User must have the API_ALERT[READ] permission to use this service","operationId":"getPlatformAlertsAnalytics","parameters":[{"name":"from","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"to","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of alerts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/alerts/status":{"get":{"tags":["API Alerts","APIs"],"summary":"Get alerting status","description":"User must have the MANAGEMENT_ALERT[READ] permission to use this service","operationId":"getApiAlertsStatus","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Alerting status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertStatusEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/alerts/{alert}":{"put":{"tags":["API Alerts","APIs"],"summary":"Update an alert for an API","description":"User must have the API_ALERT[UPDATE] permission to use this service","operationId":"updateApiAlert","parameters":[{"name":"alert","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAlertTriggerEntity"}}},"required":true},"responses":{"200":{"description":"Alert successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Alerts","APIs"],"summary":"Delete an alert for an API","description":"User must have the API_ALERT[DELETE] permission to use this service","operationId":"deleteApiAlert","parameters":[{"name":"alert","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Alert successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/alerts/{alert}/events":{"get":{"tags":["API Alerts","APIs"],"summary":"Retrieve the list of events for an alert","description":"User must have the MANAGEMENT_ALERT[READ] permission to use this service","operationId":"getApiAlertEvents","parameters":[{"name":"alert","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"to","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of events","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertEventPage"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/analytics":{"get":{"tags":["API Analytics","APIs"],"summary":"Get API analytics","description":"User must have the API_ANALYTICS[READ] permission to use this service","operationId":"getApiAnalyticsHits","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"interval","in":"query","description":"The time interval when getting histogram data (in milliseconds)","schema":{"type":"integer","format":"int64"},"example":600000},{"name":"query","in":"query","description":"The Lucene query used to filter data","schema":{"type":"string"},"example":"api:xxxx-xxxx-xxxx-xxxx AND plan:yyyy-yyyy-yyyy-yyyy AND host:\"demo.gravitee.io\" AND path:/test"},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32"}},{"name":"type","in":"query","description":"The type of data to retrieve","required":true,"schema":{"$ref":"#/components/schemas/AnalyticsType"}},{"name":"ranges","in":"query","description":"Ranges allows you to group field's data. Mainly used to group HTTP statuses code with `group_by` queries","explode":false,"schema":{"type":"array","items":{"type":"string"}},"example":"100:199,200:299,300:399,400:499,500:599"},{"name":"aggs","in":"query","description":"Aggregations are used when doing `date_histo` queries and allows you to group field's data. Mainly used to group HTTP statuses code","explode":false,"schema":{"type":"array","items":{"type":"string"}},"example":"avg:response-time,avg:api-response-time"},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API analytics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Analytics"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/audit":{"get":{"tags":["API Audits","APIs"],"summary":"Retrieve audit logs for the API","description":"User must have the API_AUDIT[READ] permission to use this service","operationId":"getApiAudits","parameters":[{"name":"environment","in":"query","schema":{"type":"string"}},{"name":"api","in":"query","schema":{"type":"string"}},{"name":"application","in":"query","schema":{"type":"string"}},{"name":"type","in":"query","description":"filter on the type of audit","schema":{"$ref":"#/components/schemas/AuditType"}},{"name":"event","in":"query","description":"filter by the name of an event.","schema":{"type":"string"},"example":"APPLICATION_UPDATED, API_CREATED, METADATA_DELETED, ..."},{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"size","in":"query","description":"Number of elements per page","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataPageAuditEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/audit/events":{"get":{"tags":["API Audits","APIs"],"summary":"List available audit event type for API","description":"User must have the API_AUDIT[READ] permission to use this service","operationId":"getApiAuditEvents","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/background":{"get":{"tags":["APIs"],"summary":"Get the API's background","description":"User must have the READ permission to use this service","operationId":"getApiBackground","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API's background","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/definition":{"get":{"tags":["API Definition","APIs"],"summary":"Export the API definition in JSON format","description":"User must have the API_DEFINITION[READ] permission to use this service","operationId":"getApiDefinition","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"500":{"description":"Internal server error"}}},"patch":{"tags":["API Definition","APIs"],"summary":"Update the API with json patches","description":"User must have the API_DEFINITION[UPDATE] permission to use this service","operationId":"patch","parameters":[{"name":"dryRun","in":"query","schema":{"type":"boolean","default":false}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JsonPatch"}}}},"required":true},"responses":{"200":{"description":"API successfully updated with json patches","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/deploy":{"post":{"tags":["APIs"],"summary":"Deploy API to gateway instances","description":"User must have the MANAGE_LIFECYCLE permission to use this service","operationId":"deployApi","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ApiDeploymentEntity"}}}},"responses":{"200":{"description":"API successfully deployed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/duplicate":{"post":{"tags":["APIs"],"summary":"Duplicate the API","description":"User must have the MANAGE_API create permission to use this service","operationId":"duplicateAPI","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/DuplicateApiEntity"}}},"required":true},"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/events":{"get":{"tags":["API Events","APIs"],"summary":"Get API's events","description":"User must have the MANAGE_LIFECYCLE permission to use this service","operationId":"getApiEventsEvents","parameters":[{"name":"type","in":"query","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/EventType"}}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API's events","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/events/search":{"get":{"tags":["API Events","APIs"],"summary":"Get API's events","description":"User must have the API_EVENT[READ] permission to use this service","operationId":"searchApiEvents","parameters":[{"name":"type","in":"query","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/EventType"}}},{"name":"from","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"api_ids","in":"query","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Page of API events","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventEntityPage"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/events/{eventId}":{"get":{"tags":["API Events","APIs"],"summary":"Get an API event with its id","description":"User must have the READ API_EVENT permission to use this service","operationId":"getEvent","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/export":{"get":{"tags":["APIs"],"summary":"Export the API definition in JSON format","description":"User must have the MANAGE_API permission to use this service","operationId":"exportApiDefinition","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","schema":{"type":"string","default":"default"}},{"name":"exclude","in":"query","schema":{"type":"string","default":""}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/groups":{"get":{"tags":["APIs"],"summary":"Get API groups mapped to members","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"getApiGroupsWithMembers","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API groups with members","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiGroupsWithMembersMap"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/headers":{"get":{"tags":["APIs"],"summary":"Get the portal API headers values","operationId":"getPortalApiHeaders","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiHeaderEntity"}}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/health":{"get":{"tags":["API Health","APIs"],"summary":"Health-check statistics for API","operationId":"getApiHealth","parameters":[{"name":"type","in":"query","schema":{"$ref":"#/components/schemas/HealthcheckType"}},{"name":"field","in":"query","schema":{"$ref":"#/components/schemas/HealthcheckField"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API health","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMetrics"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/health/average":{"get":{"tags":["API Health","APIs"],"summary":"Health-check average statistics for API","operationId":"getApiHealthAverage","parameters":[{"name":"from","in":"query","schema":{"minimum":0,"type":"integer","format":"int64"}},{"name":"to","in":"query","schema":{"minimum":0,"type":"integer","format":"int64"}},{"name":"interval","in":"query","schema":{"maximum":1000000000,"minimum":1000,"type":"integer","format":"int64"}},{"name":"type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AnalyticsAverageType"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/health/logs":{"get":{"tags":["API Health","APIs"],"summary":"Health-check logs","operationId":"getApiHealthCheckLogs","parameters":[{"name":"from","in":"query","schema":{"minimum":0,"type":"integer","format":"int64"}},{"name":"to","in":"query","schema":{"minimum":0,"type":"integer","format":"int64"}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"size","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"transition","in":"query","schema":{"type":"boolean"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchLogResponse"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/health/logs/{log}":{"get":{"tags":["API Health","APIs"],"summary":"Health-check log","operationId":"getApiHealthCheckLog","parameters":[{"name":"log","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Single health-check log","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Log"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/import":{"put":{"tags":["APIs"],"summary":"Update the API with an existing API definition in JSON format either with json or via an URL","description":"User must have the MANAGE_API permission to use this service","operationId":"updateApiWithDefinition","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}},"required":true},"responses":{"200":{"description":"API successfully updated from API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["APIs"],"summary":"Deprecated, Update the API with an existing API definition in JSON format either with json or via an URL","description":"User must have the MANAGE_API permission to use this service","operationId":"deprecated_updateApiWithDefinition","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"API successfully updated from API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}},"deprecated":true}},"/organizations/{orgId}/environments/{envId}/apis/{api}/import-path-mappings":{"post":{"tags":["APIs"],"summary":"Import path mappings from a page","description":"User must have the MANAGE_API permission to use this service","operationId":"importApiPathMappingsFromPage","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":true,"schema":{"type":"string"}},{"name":"definitionVersion","in":"query","schema":{"type":"string","default":"1.0.0"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"Path mappings successfully imported","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/import-url":{"put":{"tags":["APIs"],"summary":"Update the API with an existing API definition in JSON format either with json or via an URL","description":"User must have the MANAGE_API permission to use this service","operationId":"updateApiWithUrl","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"API successfully updated from API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/import/swagger":{"put":{"tags":["APIs"],"summary":"Update the API with an existing Swagger descriptor","description":"User must have the MANAGE_API permission to use this service","operationId":"updateApiWithSwaggerPUT","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"definitionVersion","in":"query","schema":{"type":"string","default":"1.0.0"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSwaggerDescriptorEntity"}}},"required":true},"responses":{"200":{"description":"API successfully updated from Swagger descriptor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["APIs"],"summary":"Deprecated, use PUT method instead. Update the API with an existing Swagger descriptor","description":"User must have the MANAGE_API permission to use this service","operationId":"deprecated_updateApiWithSwagger","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSwaggerDescriptorEntity"}}},"required":true},"responses":{"200":{"description":"API successfully updated from Swagger descriptor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}},"deprecated":true}},"/organizations/{orgId}/environments/{envId}/apis/{api}/logs":{"get":{"tags":["API Logs","APIs"],"summary":"Get API logs","operationId":"getApiLogs","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"The expresion used to search for logs. It looks like 'transaction:123-456-789 AND uri=\\\\/path\\\\/to\\\\/resource* AND response-time:[100 TO 200]'. Reserved characters that must be escaped + - = && \|\| > < ! ( ) { } [ ] ^ \" ~ * ? : \\ /","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"order","in":"query","description":"true means ASC order, false means DESC","schema":{"type":"boolean"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestItemSearchLogResponse"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/logs/export":{"get":{"tags":["API Logs","APIs"],"summary":"Export API logs as CSV","operationId":"exportApiLogsAsCSV","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"The expresion used to search for logs. It looks like 'transaction:123-456-789 AND uri=\\\\/path\\\\/to\\\\/resource* AND response-time:[100 TO 200]'. Reserved characters that must be escaped + - = && \|\| > < ! ( ) { } [ ] ^ \" ~ * ? : \\ /","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"order","in":"query","description":"true means ASC order, false means DESC","schema":{"type":"boolean"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API logs as CSV","content":{"text/csv":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/logs/{log}":{"get":{"tags":["API Logs","APIs"],"summary":"Get a specific log","operationId":"getApiLog","parameters":[{"name":"log","in":"path","required":true,"schema":{"type":"string"}},{"name":"timestamp","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Single log","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequest"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/media/upload":{"post":{"tags":["API Media","APIs"],"summary":"Create a media for an API","description":"User must have the API_DOCUMENTATION[CREATE] permission to use this service","operationId":"uploadApiMediaImage","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/FormDataBodyPart"}}}}}},"responses":{"201":{"description":"Media successfully created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/media/{hash}":{"get":{"tags":["API Media","APIs"],"summary":"Retrieve a media for an API","operationId":"getApiMediaImage","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"hash","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/members":{"get":{"tags":["API Memberships","APIs"],"summary":"List API members","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"getApiMembers","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of API's members","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MembershipListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Memberships","APIs"],"summary":"Add or update an API member","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"addOrUpdateApiMember","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ApiMembership"}}},"required":true},"responses":{"201":{"description":"Member has been added or updated successfully"},"400":{"description":"Membership parameter is not valid"},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Memberships","APIs"],"summary":"Remove an API member","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"deleteApiMember","parameters":[{"name":"user","in":"query","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Member has been removed successfully"},"400":{"description":"User does not exist"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/members/permissions":{"get":{"tags":["API Memberships","APIs"],"summary":"Get API members","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"getApiMembersPermissions","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API member's permissions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MemberEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/members/transfer_ownership":{"post":{"tags":["API Memberships","APIs"],"summary":"Transfer the ownership of the API","description":"User must have the TRANSFER_OWNERSHIP permission to use this service","operationId":"transferApiMemberOwnership","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/TransferOwnership"}}},"required":true},"responses":{"200":{"description":"Ownership has been transferred successfully"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/messages":{"post":{"tags":["APIs"],"summary":"Send a message to existing consumers of an API","description":"User must have the API_MESSAGE[CREATE] permission to use this service","operationId":"createApiMessage","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageEntity"}}}},"responses":{"200":{"description":"Message successfully sent, the resulting integer is the number of recipients that were found","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/metadata":{"get":{"tags":["API Metadata","APIs"],"summary":"List metadata for the given API","description":"User must have the API_METADATA[READ] permission to use this service","operationId":"getApiMetadatas","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of metadata","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiMetadataEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Metadata","APIs"],"summary":"Create an API metadata","description":"User must have the API_METADATA[CREATE] permission to use this service","operationId":"createApiMetadata","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApiMetadataEntity"}}},"required":true},"responses":{"201":{"description":"A new API metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMetadataEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/metadata/{metadata}":{"get":{"tags":["API Metadata","APIs"],"summary":"A metadata for the given API and metadata id","description":"User must have the API_METADATA[READ] permission to use this service","operationId":"getApiMetadata","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMetadataEntity"}}}},"404":{"description":"Metadata not found"},"500":{"description":"Internal server error"}}},"put":{"tags":["API Metadata","APIs"],"summary":"Update an API metadata","description":"User must have the API_METADATA[UPDATE] permission to use this service","operationId":"updateApiMetadata","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiMetadataEntity"}}},"required":true},"responses":{"201":{"description":"API metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMetadataEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Metadata","APIs"],"summary":"Delete a metadata","description":"User must have the API_METADATA[DELETE] permission to use this service","operationId":"deleteApiMetadata","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Metadata successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/notificationsettings":{"get":{"tags":["API Notifications","APIs"],"summary":"Get notification settings","operationId":"getApiNotificationSettings","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}},"put":{"tags":["API Notifications","APIs"],"summary":"Update portal notification settings","operationId":"updateApiPortalNotificationSettings","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalNotificationConfigEntity"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalNotificationConfigEntity"}}}}}},"post":{"tags":["API Notifications","APIs"],"summary":"Create notification settings","operationId":"createApiNotificationSettings","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericNotificationConfigEntity"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/notificationsettings/{notificationId}":{"put":{"tags":["API Notifications","APIs"],"summary":"Update generic notification settings","operationId":"updateApiGeneralNotificationSettings","parameters":[{"name":"notificationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericNotificationConfigEntity"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericNotificationConfigEntity"}}}}}},"delete":{"tags":["API Notifications","APIs"],"summary":"Delete notification settings","operationId":"deleteApiNotificationSettings","parameters":[{"name":"notificationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/notifiers":{"get":{"tags":["APIs"],"summary":"List available notifiers for API","description":"User must have the API_NOTIFICATION[READ] permission to use this service","operationId":"getApiNotifiers","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotifierEntity"}}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/pages":{"get":{"tags":["API Pages","APIs"],"summary":"List pages","description":"User must have the READ permission to use this service","operationId":"getApiPages","parameters":[{"name":"Accept-Language","in":"header","schema":{"type":"string"}},{"name":"homepage","in":"query","schema":{"type":"boolean"}},{"name":"type","in":"query","schema":{"$ref":"#/components/schemas/PageType"}},{"name":"parent","in":"query","schema":{"type":"string"}},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"root","in":"query","schema":{"type":"boolean"}},{"name":"translated","in":"query","schema":{"type":"boolean"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of pages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Pages","APIs"],"summary":"Create a page","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"createApiPage","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/pages/_fetch":{"post":{"tags":["API Pages","APIs"],"summary":"Refresh all pages by calling their associated fetcher","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"fetchAllApiPages","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"Pages successfully refreshed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/pages/_import":{"put":{"tags":["API Pages","APIs"],"summary":"Import pages","description":"User must be ADMIN to use this service","operationId":"updateApiPageImportFiles","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportPageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Pages","APIs"],"summary":"Import pages","description":"User must be ADMIN to use this service","operationId":"importApiPageFiles","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportPageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/pages/{page}":{"get":{"tags":["API Pages","APIs"],"summary":"Get a page","description":"User must have the READ permission to use this service","operationId":"getApiPage","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept-Language","in":"header","schema":{"type":"string"}},{"name":"portal","in":"query","schema":{"type":"boolean"}},{"name":"translated","in":"query","schema":{"type":"boolean"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["API Pages","APIs"],"summary":"Update a page","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"updateApiPage","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Pages","APIs"],"summary":"Delete a page","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"deleteApiPage","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Page successfully deleted"},"500":{"description":"Internal server error"}}},"patch":{"tags":["API Pages","APIs"],"summary":"Update a page","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"partialUpdateApiPage","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePageEntity"}}}},"responses":{"201":{"description":"Page successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/pages/{page}/_fetch":{"post":{"tags":["API Pages","APIs"],"summary":"Refresh page by calling the associated fetcher","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"fetchApiPage","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"Page successfully refreshed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/pages/{page}/content":{"get":{"tags":["API Pages","APIs"],"summary":"Get the page's content","description":"User must have the READ permission to use this service","operationId":"getApiPageContent","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Page's content","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["API Pages","APIs"],"summary":"Put the page's content","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"updatePageContent","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"201":{"description":"Page content successfully updated"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/pages/{page}/media":{"get":{"tags":["API Media","API Pages","APIs"],"summary":"Retrieve all media for an API page","description":"User must have the API_DOCUMENTATION[READ] permission to use this service","operationId":"getApiPageMedia","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"tags":["API Media","API Pages","APIs"],"summary":"Attach a media to an API page ","description":"User must have the API_DOCUMENTATION[UPDATE] permission to use this service","operationId":"attachApiPageMedia","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/FormDataBodyPart"},"fileName":{"type":"string"}}}}}},"responses":{"201":{"description":"Media successfully added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/picture":{"get":{"tags":["APIs"],"summary":"Get the API's picture","description":"User must have the READ permission to use this service","operationId":"getApiPicture","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API's picture","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/plans":{"get":{"tags":["API Plans","APIs"],"summary":"List plans for an API","description":"List all the plans accessible to the current user.","operationId":"getApiPlans","parameters":[{"name":"status","in":"query","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlanStatus"}}},{"name":"security","in":"query","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlanSecurityType"}}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List accessible plans for current user","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PlanEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Plans","APIs"],"summary":"Create a plan","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"createApiPlan","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPlanEntity"}}},"required":true},"responses":{"201":{"description":"Plan successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/plans/{plan}":{"get":{"tags":["API Plans","APIs"],"summary":"Get a plan","description":"User must have the READ permission to use this service","operationId":"getApiPlan","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Plan information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["API Plans","APIs"],"summary":"Update a plan","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"updateApiPlan","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlanEntity"}}},"required":true},"responses":{"200":{"description":"Plan successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntity"}}}},"400":{"description":"Bad plan format"},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Plans","APIs"],"summary":"Delete a plan","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"deleteApiPlan","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/plans/{plan}/_close":{"post":{"tags":["API Plans","APIs"],"summary":"Close a plan","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"closeApiPlan","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully closed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/plans/{plan}/_deprecate":{"post":{"tags":["API Plans","APIs"],"summary":"Deprecate a plan","description":"User must have the API_PLAN[UPDATE] permission to use this service","operationId":"deprecateApiPlan","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully deprecated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/plans/{plan}/_depreciate":{"post":{"tags":["API Plans","APIs"],"summary":"Deprecated, use '_deprecate' instead. Deprecate a plan","description":"User must have the API_PLAN[UPDATE] permission to use this service","operationId":"depreciateApiPlan","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully deprecated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntity"}}}},"500":{"description":"Internal server error"}},"deprecated":true}},"/organizations/{orgId}/environments/{envId}/apis/{api}/plans/{plan}/_publish":{"post":{"tags":["API Plans","APIs"],"summary":"Publicly publish plan","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"publishApiPlan","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully published","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/quality":{"get":{"tags":["APIs"],"summary":"Get the quality metrics of the API","operationId":"getApiQualityMetrics","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiQualityMetricsEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/quality-rules":{"get":{"tags":["API Quality","APIs"],"summary":"List quality rules for an API","description":"User must have the API_QUALITY_RULE[READ] permission to use this service","operationId":"getApiQualityRules","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiQualityRuleEntity"}}}}}}},"post":{"tags":["API Quality","APIs"],"summary":"Create a new quality rules for an API","description":"User must have the API_QUALITY_RULE[CREATE] permission to use this service","operationId":"createApiQualityRule","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApiQualityRuleEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiQualityRuleEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/quality-rules/{qualityRule}":{"put":{"tags":["API Quality","APIs"],"summary":"Update an existing quality rules for an API","description":"User must have the API_QUALITY_RULE[UPDATE] permission to use this service","operationId":"updateApiQualityRule","parameters":[{"name":"qualityRule","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiQualityRuleEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiQualityRuleEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/ratings":{"get":{"tags":["API Ratings","APIs"],"summary":"List ratings for an API","operationId":"getApiRating","parameters":[{"name":"pageNumber","in":"query","schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRatingEntity"}}}}}},"post":{"tags":["API Ratings","APIs"],"summary":"Create a new rating for an API","description":"User must have the API_RATING[CREATE] permission to use this service","operationId":"createApiRating","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewRatingEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/ratings/current":{"get":{"tags":["API Ratings","APIs"],"summary":"Retrieve current rating for an API provided by the authenticated user","operationId":"getApiRatingByApiAndUser","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/ratings/summary":{"get":{"tags":["API Ratings","APIs"],"summary":"Get the rating summary for an API","operationId":"getApiRatingSummaryByApi","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingSummaryEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating}":{"put":{"tags":["API Ratings","APIs"],"summary":"Update an existing rating for an API","description":"User must have the API_RATING[UPDATE] permission to use this service","operationId":"updateApiRating","parameters":[{"name":"rating","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRatingEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingEntity"}}}}}},"delete":{"tags":["API Ratings","APIs"],"summary":"Delete an existing rating for an API","description":"User must have the API_RATING[DELETE] permission to use this service","operationId":"deleteApiRating","parameters":[{"name":"rating","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating}/answers":{"post":{"tags":["API Ratings","APIs"],"summary":"Create an answer to a rating for an API","description":"User must have the API_RATING_ANSWER[CREATE] permission to use this service","operationId":"createApiRatingAnswer","parameters":[{"name":"rating","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewRatingAnswerEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating}/answers/{answer}":{"delete":{"tags":["API Ratings","APIs"],"summary":"Delete an answer to a rating for an API","description":"User must have the API_RATING_ANSWER[DELETE] permission to use this service","operationId":"deleteApiRatingAnswer","parameters":[{"name":"rating","in":"path","required":true,"schema":{"type":"string"}},{"name":"answer","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/reviews":{"post":{"tags":["APIs"],"summary":"Manage the API's review state","description":"User must have the API_DEFINITION[UPDATE] or API_REVIEWS[UPDATE] permission to use this service (depending on the action)","operationId":"doApiReviewAction","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ReviewAction"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ReviewEntity"}}}},"responses":{"204":{"description":"Updated API"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/rollback":{"post":{"tags":["APIs"],"summary":"Rollback API to a previous version","description":"User must have the MANAGE_LIFECYCLE permission to use this service","operationId":"rollbackApi","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/RollbackApiEntity"}}},"required":true},"responses":{"200":{"description":"API successfully rollbacked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/state":{"get":{"tags":["APIs"],"summary":"Get the state of the API","description":"User must have the MANAGE_LIFECYCLE permission to use this service","operationId":"isApiSynchronized","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API's state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiStateEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscribers":{"get":{"tags":["API Subscriptions","APIs"],"summary":"List subscribers for the API","description":"User must have the MANAGE_SUBSCRIPTIONS permission to use this service","operationId":"getApiSubscribers","parameters":[{"name":"query","in":"query","schema":{"type":"string"}},{"name":"exclude","in":"query","schema":{"type":"array","items":{"type":"string","enum":["PICTURE","OWNER"]}}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Paged result of API subscribers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions":{"get":{"tags":["API Subscriptions","APIs"],"summary":"List subscriptions for the API","description":"User must have the READ_SUBSCRIPTION permission to use this service","operationId":"getApiSubscriptions","parameters":[{"name":"plan","in":"query","description":"plan","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"application","in":"query","description":"application","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"status","in":"query","description":"Comma separated list of Subscription status, default is ACCEPTED","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionStatus"}}},{"name":"api_key","in":"query","schema":{"type":"string"}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"expand","in":"query","description":"Expansion of data to return in subscriptions","schema":{"type":"array","items":{"type":"string","enum":["keys","security"]}}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Paged result of API's subscriptions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntityPageResult"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Subscriptions","APIs"],"summary":"Subscribe to a plan","description":"User must have the MANAGE_SUBSCRIPTIONS permission to use this service","operationId":"createSubscriptionToApi","parameters":[{"name":"application","in":"query","required":true,"schema":{"type":"string"}},{"name":"plan","in":"query","required":true,"schema":{"type":"string"}},{"name":"customApiKey","in":"query","schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSubscriptionConfigurationEntity"}}}},"responses":{"201":{"description":"Subscription successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Bad custom API Key format or custom API Key definition disabled"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/_canCreate":{"get":{"tags":["API Subscriptions","APIs"],"summary":"Check a subscription can be created with given api key, and application","description":"User must have the API_SUBSCRIPTION:READ permission to use this service","operationId":"verifyApiKeyCreation","parameters":[{"name":"key","in":"query","required":true,"schema":{"type":"string"}},{"name":"application","in":"query","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API Key creation successfully checked","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Bad API Key parameter"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/export":{"get":{"tags":["API Subscriptions","APIs"],"summary":"Export API logs as CSV","operationId":"exportApiSubscriptionsLogsAsCSV","parameters":[{"name":"plan","in":"query","description":"plan","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"application","in":"query","description":"application","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"status","in":"query","description":"Comma separated list of Subscription status, default is ACCEPTED","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionStatus"}}},{"name":"api_key","in":"query","schema":{"type":"string"}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API logs as CSV","content":{"text/csv":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/{subscription}":{"get":{"tags":["API Subscriptions","APIs"],"summary":"Get a subscription","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"getApiSubscription","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Get a subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"404":{"description":"Subscription does not exist"},"500":{"description":"Internal server error"}}},"put":{"tags":["API Subscriptions","APIs"],"summary":"Update a subscription","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"updateApiSubscription","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionEntity"}}},"required":true},"responses":{"200":{"description":"Update a subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Bad subscription format"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/{subscription}/_process":{"post":{"tags":["API Subscriptions","APIs"],"summary":"Update a subscription","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"processApiSubscription","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ProcessSubscriptionEntity"}}},"required":true},"responses":{"200":{"description":"Update a subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Bad subscription format"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/{subscription}/_transfer":{"post":{"tags":["API Subscriptions","APIs"],"summary":"Transfer a subscription","description":"User must have the API_SUBSCRIPTION update permission to use this service","operationId":"transferApiSubscription","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/TransferSubscriptionEntity"}}},"required":true},"responses":{"200":{"description":"Update a subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Bad subscription format"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/{subscription}/apikeys":{"get":{"tags":["API Keys","API Subscriptions","APIs"],"summary":"List all API Keys for a subscription","description":"User must have the MANAGE_API_KEYS permission to use this service","operationId":"getApiKeysForApiSubscription","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of API Keys for a subscription","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/{subscription}/apikeys/_renew":{"post":{"tags":["API Keys","API Subscriptions","APIs"],"summary":"Renew an API key","description":"User must have the MANAGE_API_KEYS permission to use this service","operationId":"renewSubscriptionApiKeysForApiSubscription","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"customApiKey","in":"query","schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"A new API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}}},"400":{"description":"Bad custom API Key format or custom API Key definition disabled"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/{subscription}/apikeys/{apikey}":{"put":{"tags":["API Keys","API Subscriptions","APIs"],"summary":"Update API Key","description":"User must have the API_SUBSCRIPTION:UPDATE permission to use this service","operationId":"updateApiKeyForApiSubscription","parameters":[{"name":"apikey","in":"path","required":true,"schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}},"required":true},"responses":{"200":{"description":"API Key successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}}},"400":{"description":"Bad API Key key format"},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Keys","API Subscriptions","APIs"],"summary":"Revoke API key","description":"User must have the API_SUBSCRIPTION:DELETE permission to use this service","operationId":"revokeApiKeyForApiSubscription","parameters":[{"name":"apikey","in":"path","required":true,"schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/{subscription}/apikeys/{apikey}/_reactivate":{"post":{"tags":["API Keys","API Subscriptions","APIs"],"summary":"Reactivate an API key","description":"User must have the API_SUBSCRIPTION permission to use this service","operationId":"reactivateApiKeyForApiSubscription","parameters":[{"name":"apikey","in":"path","required":true,"schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"API key successfully reactivated"},"400":{"description":"API Key does not correspond to the subscription"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/apis/{api}/subscriptions/{subscription}/status":{"post":{"tags":["API Subscriptions","APIs"],"summary":"Change the status of a subscription","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"changeApiSubscriptionStatus","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SubscriptionStatus"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Subscription status successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Status changes not authorized"},"404":{"description":"API subscription does not exist"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications":{"get":{"tags":["Applications"],"summary":"List all the applications accessible to authenticated user","description":"User must have MANAGEMENT_APPLICATION[READ] and PORTAL_APPLICATION[READ] permission to list applications. User must have ORGANIZATION:ADMIN role to list all ARCHIVED applications.","operationId":"getApplications","parameters":[{"name":"group","in":"query","schema":{"type":"string"}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string","default":"ACTIVE"}},{"name":"ids","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude","in":"query","schema":{"type":"array","items":{"type":"string","enum":["PICTURE","OWNER"]}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's applications","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationEntity"}}}}},"500":{"description":"Internal server error"}},"deprecated":true},"post":{"tags":["Applications"],"summary":"Create an application","description":"User must have MANAGEMENT_APPLICATION[CREATE] permission to create an application.","operationId":"createApplication","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApplicationEntity"}}},"required":true},"responses":{"201":{"description":"Application successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/_paged":{"get":{"tags":["Applications"],"summary":"List all the applications accessible to authenticated user","description":"User must have MANAGEMENT_APPLICATION[READ] and PORTAL_APPLICATION[READ] permission to list applications. User must have ORGANIZATION:ADMIN role to list all ARCHIVED applications.","operationId":"getApplicationsPaged","parameters":[{"name":"group","in":"query","schema":{"type":"string"}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string","default":"ACTIVE"}},{"name":"ids","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"order","in":"query","schema":{"type":"string","description":"By default, sort is ASC. If field starts with '-', the order sort is DESC. Currently, only name and updated_at are supported","default":"name"}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"exclude","in":"query","schema":{"type":"array","items":{"type":"string","enum":["PICTURE","OWNER"]}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's applications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationListItemPagedResult"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/hooks":{"get":{"tags":["Applications"],"summary":"Get the list of available hooks","operationId":"getApplicationHooks","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of hooks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Hook"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}":{"get":{"tags":["Applications"],"summary":"Get an application","description":"User must have the READ permission to use this service","operationId":"getApplication","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Application","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Applications"],"summary":"Update an application","description":"User must have APPLICATION_DEFINITION[UPDATE] permission to update an application.","operationId":"updateApplication","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApplicationEntity"}}},"required":true},"responses":{"200":{"description":"Updated application","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Applications"],"summary":"Delete an application","description":"User must have the DELETE permission to use this service","operationId":"deleteApplication","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Application successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/_restore":{"post":{"tags":["Applications"],"summary":"Restore the application","description":"User must have ORGANIZATION:ADMIN role to restore an application.","operationId":"restoreApplication","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Restored application","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/alerts":{"get":{"tags":["Application Alerts","Applications"],"summary":"List configured alerts of an application","description":"User must have the APPLICATION_ALERT[READ] permission to use this service","operationId":"getApplicationAlerts","parameters":[{"name":"event_counts","in":"query","schema":{"type":"boolean","default":true}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of alerts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Application Alerts","Applications"],"summary":"Create an alert for an application","description":"User must have the APPLICATION_ALERT[CREATE] permission to use this service","operationId":"createApplicationAlert","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewAlertTriggerEntity"}}},"required":true},"responses":{"200":{"description":"Alert successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/alerts/status":{"get":{"tags":["Application Alerts","Applications"],"summary":"Get alerting status","description":"User must have the MANAGEMENT_ALERT[READ] permission to use this service","operationId":"getApplicationAlertsStatus","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Alerting status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertStatusEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/alerts/{alert}":{"put":{"tags":["Application Alerts","Applications"],"summary":"Update an alert for an application","description":"User must have the APPLICATION_ALERT[UPDATE] permission to use this service","operationId":"updateApplicationAlert","parameters":[{"name":"alert","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAlertTriggerEntity"}}},"required":true},"responses":{"200":{"description":"Alert successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Application Alerts","Applications"],"summary":"Delete an alert for an application","description":"User must have the APPLICATION_ALERT[DELETE] permission to use this service","operationId":"deleteApplicationAlert","parameters":[{"name":"alert","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Alert successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/analytics":{"get":{"tags":["Application Analytics","Applications"],"summary":"Get application analytics","description":"User must have the APPLICATION_ANALYTICS[READ] permission to use this service","operationId":"getApplicationAnalyticsHits","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"interval","in":"query","description":"The time interval when getting histogram data (in milliseconds)","schema":{"type":"integer","format":"int64"},"example":600000},{"name":"query","in":"query","description":"The Lucene query used to filter data","schema":{"type":"string"},"example":"api:xxxx-xxxx-xxxx-xxxx AND plan:yyyy-yyyy-yyyy-yyyy AND host:\"demo.gravitee.io\" AND path:/test"},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32"}},{"name":"type","in":"query","description":"The type of data to retrieve","required":true,"schema":{"$ref":"#/components/schemas/AnalyticsType"}},{"name":"ranges","in":"query","description":"Ranges allows you to group field's data. Mainly used to group HTTP statuses code with `group_by` queries","explode":false,"schema":{"type":"array","items":{"type":"string"}},"example":"100:199,200:299,300:399,400:499,500:599"},{"name":"aggs","in":"query","description":"Aggregations are used when doing `date_histo` queries and allows you to group field's data. Mainly used to group HTTP statuses code","explode":false,"schema":{"type":"array","items":{"type":"string"}},"example":"avg:response-time,avg:api-response-time"},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Application analytics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Analytics"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/apikeys":{"get":{"tags":["API Keys","Applications"],"summary":"List all API Keys for an application","description":"User must have the READ permission to use this service","operationId":"getApiKeysForApplication","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of API Keys for application","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/apikeys/_renew":{"post":{"tags":["API Keys","Applications"],"summary":"Renew an API key","description":"User must have the MANAGE_API_KEYS permission to use this service","operationId":"renewApiKeyForApplicationSubscription","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"A new API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/apikeys/{apikey}":{"delete":{"tags":["API Keys","Applications"],"summary":"Revoke an API key","description":"User must have the MANAGE_API_KEYS permission to use this service","operationId":"revokeApiKeyForApplication","parameters":[{"name":"apikey","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"API key successfully revoked"},"400":{"description":"API Key does not correspond to the application"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/background":{"get":{"tags":["Applications"],"summary":"Get the application's background","description":"User must have the READ permission to use this service","operationId":"getApplicationBackground","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Application's background","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/configuration":{"get":{"tags":["Applications"],"summary":"Get application type definition of an application","description":"User must have the READ permission to use this service","operationId":"getApplicationType","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"ApplicationType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationTypeEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/logs":{"get":{"tags":["Application Logs","Applications"],"summary":"Get application logs","operationId":"getApplicationLogs","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"The expresion used to search for logs. It looks like 'transaction:123-456-789 AND uri=\\\\/path\\\\/to\\\\/resource* AND response-time:[100 TO 200]'. Reserved characters that must be escaped + - = && \|\| > < ! ( ) { } [ ] ^ \" ~ * ? : \\ /","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"order","in":"query","description":"true means ASC order, false means DESC","schema":{"type":"boolean"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Application logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationRequestItemSearchLogResponse"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/logs/export":{"get":{"tags":["Application Logs","Applications"],"summary":"Export application logs as CSV","operationId":"exportApplicationLogsAsCSV","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"The expresion used to search for logs. It looks like 'transaction:123-456-789 AND uri=\\\\/path\\\\/to\\\\/resource* AND response-time:[100 TO 200]'. Reserved characters that must be escaped + - = && \|\| > < ! ( ) { } [ ] ^ \" ~ * ? : \\ /","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"order","in":"query","description":"true means ASC order, false means DESC","schema":{"type":"boolean"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Application logs as CSV","content":{"text/csv":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/logs/{log}":{"get":{"tags":["Application Logs","Applications"],"summary":"Get a specific log","operationId":"getApplicationLog","parameters":[{"name":"log","in":"path","required":true,"schema":{"type":"string"}},{"name":"timestamp","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Single log","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationRequest"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/members":{"get":{"tags":["Application Memberships","Applications"],"summary":"List application members","description":"User must have the READ permission to use this service","operationId":"getApplicationMembers","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Application successfully deleted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MembershipListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Application Memberships","Applications"],"summary":"Add or update an application member","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"addOrUpdateApplicationMember","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ApplicationMembership"}}},"required":true},"responses":{"201":{"description":"Member has been added or updated successfully"},"400":{"description":"Membership parameter is not valid"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Application Memberships","Applications"],"summary":"Remove an application member","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"deleteApplicationMember","parameters":[{"name":"user","in":"query","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Member has been removed successfully"},"400":{"description":"User does not exist"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/members/permissions":{"get":{"tags":["Application Memberships","Applications"],"summary":"Get application members","description":"User must have the APPLICATION_MEMBER permission to use this service","operationId":"getApplicationMemberPermissions","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Application member's permissions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MemberEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/members/transfer_ownership":{"post":{"tags":["Application Memberships","Applications"],"summary":"Transfer the ownership of the APPLICATION","description":"User must have the TRANSFER_OWNERSHIP permission to use this service","operationId":"transferApplicationOwnership","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/TransferOwnership"}}},"required":true},"responses":{"200":{"description":"Ownership has been transferred successfully"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/metadata":{"get":{"tags":["Application Metadata","Applications"],"summary":"List metadata for an application","description":"User must have the APPLICATION_METADATA[READ] permission to use this service","operationId":"getApplicationMetadatas","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of metadata for an application","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationMetadataEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Application Metadata","Applications"],"summary":"Create an application metadata","description":"User must have the APPLICATION_METADATA[CREATE] permission to use this service","operationId":"createApplicationMetadata","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApplicationMetadataEntity"}}},"required":true},"responses":{"201":{"description":"Application metadata successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMetadataEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/metadata/{metadata}":{"get":{"tags":["Application Metadata","Applications"],"summary":"A metadata for an application and metadata id","description":"User must have the APPLICATION_METADATA[READ] permission to use this service","operationId":"getApplicationMetadata","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMetadataEntity"}}}},"404":{"description":"Metadata not found"},"500":{"description":"Internal server error"}}},"put":{"tags":["Application Metadata","Applications"],"summary":"Update an application metadata","description":"User must have the APPLICATION_METADATA[UPDATE] permission to use this service","operationId":"updateApplicationMetadata","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApplicationMetadataEntity"}}},"required":true},"responses":{"200":{"description":"Updated application metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMetadataEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Application Metadata","Applications"],"summary":"Delete a metadata","description":"User must have the APPLICATION_METADATA[DELETE] permission to use this service","operationId":"deleteApplicationMetadata","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Metadata successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/notificationsettings":{"get":{"tags":["Application Notifications","Applications"],"summary":"Get notification settings","operationId":"getApplicationNotificationSettings","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}},"put":{"tags":["Application Notifications","Applications"],"summary":"Update portal notification settings","operationId":"updateApplicationPortalNotificationSettings","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalNotificationConfigEntity"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalNotificationConfigEntity"}}}}}},"post":{"tags":["Application Notifications","Applications"],"summary":"Create notification settings","operationId":"createApplicationNotificationSettings","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericNotificationConfigEntity"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/notificationsettings/{notificationId}":{"put":{"tags":["Application Notifications","Applications"],"summary":"Update generic notification settings","operationId":"updateApplicationGeneralNotificationSettings","parameters":[{"name":"notificationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericNotificationConfigEntity"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericNotificationConfigEntity"}}}}}},"delete":{"tags":["Application Notifications","Applications"],"summary":"Delete notification settings","operationId":"deleteApplicationNotificationSettings","parameters":[{"name":"notificationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/notifiers":{"get":{"tags":["Applications"],"summary":"List available notifiers for application","description":"User must have the APPLICATION_NOTIFICATION[READ] permission to use this service","operationId":"getApplicationNotifiers","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of notifiers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotifierEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/picture":{"get":{"tags":["Applications"],"summary":"Get the application's picture","description":"User must have the READ permission to use this service","operationId":"getApplicationPicture","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Application's picture","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/renew_secret":{"post":{"tags":["Applications"],"summary":"Renew the client secret for an OAuth2 application","description":"User must have APPLICATION_DEFINITION[UPDATE] permission to update an application.","operationId":"renewApplicationClientSecret","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Updated application","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/subscribed":{"get":{"tags":["Application Subscriptions","Applications"],"summary":"List APIs subscribed by the application","description":"User must have the APPLICATION_SUBSCRIPTION permission to use this service","operationId":"getApiSubscribed","parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Paged result of subscribed APIs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/subscriptions":{"get":{"tags":["Application Subscriptions","Applications"],"summary":"List subscriptions for the application","description":"User must have the READ_SUBSCRIPTION permission to use this service","operationId":"getApplicationSubscriptions","parameters":[{"name":"plan","in":"query","description":"plan","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"api","in":"query","description":"api","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"status","in":"query","description":"Comma separated list of Subscription status, default is ACCEPTED","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionStatus"}}},{"name":"api_key","in":"query","schema":{"type":"string"}},{"name":"security_types","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"expand","in":"query","description":"Expansion of data to return in subscriptions","schema":{"type":"array","items":{"type":"string","enum":["keys","security"]}}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Paged result of application's subscriptions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntityPageResult"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Application Subscriptions","Applications"],"summary":"Subscribe to a plan","description":"User must have the MANAGE_SUBSCRIPTIONS permission to use this service","operationId":"createSubscriptionWithApplication","parameters":[{"name":"plan","in":"query","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/NewSubscriptionEntity"}}}},"responses":{"201":{"description":"Subscription successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/subscriptions/{subscription}":{"get":{"tags":["Application Subscriptions","Applications"],"summary":"Get subscription information","description":"User must have the READ permission to use this service","operationId":"getApplicationSubscription","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Subscription information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Application Subscriptions","Applications"],"summary":"Close the subscription","description":"User must have the APPLICATION_SUBSCRIPTION[DELETE] permission to use this service","operationId":"closeApplicationSubscription","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Subscription has been closed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/subscriptions/{subscription}/apikeys":{"get":{"tags":["API Keys","Application Subscriptions","Applications"],"summary":"List all API Keys for a subscription","description":"User must have the READ permission to use this service","operationId":"getApiKeysForApplicationSubscription","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of API Keys for a subscription","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ApiKeyEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/subscriptions/{subscription}/apikeys/_renew":{"post":{"tags":["API Keys","Application Subscriptions","Applications"],"summary":"Renew an API key","description":"User must have the MANAGE_API_KEYS permission to use this service","operationId":"renewApiKeyForApplicationSubscription_1","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"A new API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/applications/{application}/subscriptions/{subscription}/apikeys/{apikey}":{"delete":{"tags":["API Keys","Application Subscriptions","Applications"],"summary":"Revoke an API key","description":"User must have the MANAGE_API_KEYS permission to use this service","operationId":"revokeApiKeyForApplicationSubscription","parameters":[{"name":"apikey","in":"path","required":true,"schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"application","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"API key successfully revoked"},"400":{"description":"API Key does not correspond to the subscription"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/audit":{"get":{"tags":["Audit"],"summary":"Retrieve audit logs for the environment","description":"User must have the ENVIRONMENT_AUDIT[READ] or ORGANIZATION_AUDIT[READ] permission to use this service","operationId":"getAudits_1","parameters":[{"name":"environment","in":"query","schema":{"type":"string"}},{"name":"api","in":"query","schema":{"type":"string"}},{"name":"application","in":"query","schema":{"type":"string"}},{"name":"type","in":"query","description":"filter on the type of audit","schema":{"$ref":"#/components/schemas/AuditType"}},{"name":"event","in":"query","description":"filter by the name of an event.","schema":{"type":"string"},"example":"APPLICATION_UPDATED, API_CREATED, METADATA_DELETED, ..."},{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"size","in":"query","description":"Number of elements per page","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditEntityMetadataPage"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/audit/events":{"get":{"tags":["Audit"],"summary":"List available audit event type for the environment","description":"User must have the ENVIRONMENT_AUDIT[READ] or ORGANIZATION_AUDIT[READ] permission to use this service","operationId":"getAuditEvents_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of audits","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditEvent"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/auth/oauth2/{identity}":{"post":{"tags":["Authentication"],"operationId":"exchangeAuthorizationCode","parameters":[{"name":"identity","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/Payload"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/auth/oauth2/{identity}/exchange":{"post":{"tags":["Authentication"],"operationId":"tokenExchange_1","parameters":[{"name":"identity","in":"path","required":true,"schema":{"type":"string"}},{"name":"token","in":"query","schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/apiheaders":{"get":{"tags":["Configuration"],"summary":"List API headers","operationId":"getApiHeaders","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of API headers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiHeaderEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Configuration"],"summary":"Create an API header","description":"User must have the PORTAL_API_HEADER[CREATE] permission to use this service","operationId":"createApiHeader","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApiHeaderEntity"}}},"required":true},"responses":{"200":{"description":"API header successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiHeaderEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/apiheaders/{id}":{"put":{"tags":["Configuration"],"summary":"Update an API header","description":"User must have the PORTAL_API_HEADER[UPDATE] permission to use this service","operationId":"updateApiHeader","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiHeaderEntity"}}},"required":true},"responses":{"200":{"description":"API header successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiHeaderEntity"}}}},"404":{"description":"API header not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Configuration"],"summary":"Delete an API header","description":"User must have the PORTAL_API_HEADER[DELETE] permission to use this service","operationId":"deleteApiHeader","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API header successfully deleted"},"404":{"description":"API header not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/applications/registration/providers":{"get":{"tags":["Client Registration Providers","Configuration"],"summary":"Get the list of client registration providers","description":"User must have the PORTAL_CLIENT_REGISTRATION_PROVIDER[READ] permission to use this service","operationId":"getClientRegistrationProviders","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List client registration providers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClientRegistrationProviderListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Client Registration Providers","Configuration"],"summary":"Create a client registration provider","description":"User must have the PORTAL_CLIENT_REGISTRATION_PROVIDER[CREATE] permission to use this service","operationId":"createClientRegistrationProvider","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewClientRegistrationProviderEntity"}}},"required":true},"responses":{"201":{"description":"Client registration provider provider successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRegistrationProviderEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/applications/registration/providers/{clientRegistrationProvider}":{"get":{"tags":["Client Registration Providers","Configuration"],"summary":"Get a client registration provider","description":"User must have the PORTAL_CLIENT_REGISTRATION_PROVIDER[READ] permission to use this service","operationId":"getClientRegistrationProvider","parameters":[{"name":"clientRegistrationProvider","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A client registration provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRegistrationProviderEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Client Registration Providers","Configuration"],"summary":"Update a client registration provider","description":"User must have the PORTAL_CLIENT_REGISTRATION_PROVIDER[UPDATE] permission to use this service","operationId":"updateClientRegistrationProvider","parameters":[{"name":"clientRegistrationProvider","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientRegistrationProviderEntity"}}},"required":true},"responses":{"200":{"description":"Updated client registration provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRegistrationProviderEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Client Registration Providers","Configuration"],"summary":"Delete a client registration provider","description":"User must have the PORTAL_CLIENT_REGISTRATION_PROVIDER[DELETE] permission to use this service","operationId":"deleteClientRegistrationProvider","parameters":[{"name":"clientRegistrationProvider","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Client registration provider successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/applications/types":{"get":{"tags":["Configuration"],"summary":"Get the list of enabled application types","operationId":"getEnabledApplicationTypes","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/categories":{"get":{"tags":["Categories","Configuration"],"summary":"Retrieve list of categories","operationId":"getCategories","parameters":[{"name":"include","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryEntity"}}}}}}},"put":{"tags":["Categories","Configuration"],"summary":"Update an existing category","description":"User must have the PORTAL_CATEGORY[UPDATE] permission to use this service","operationId":"updateCategories","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateCategoryEntity"}}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryEntity"}}}}}}},"post":{"tags":["Categories","Configuration"],"summary":"Create a category","description":"User must have the PORTAL_CATEGORY[CREATE] permission to use this service","operationId":"createCategory","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewCategoryEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId}":{"get":{"tags":["Categories","Configuration"],"summary":"Get the category","description":"User must have the PORTAL_CATEGORY[READ] permission to use this service","operationId":"getCategory","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Category's definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Categories","Configuration"],"summary":"Update the category","description":"User must have the PORTAL_CATEGORY[UPDATE] permission to use this service","operationId":"updateCategory","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCategoryEntity"}}},"required":true},"responses":{"200":{"description":"Category successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Categories","Configuration"],"summary":"Delete the category","description":"User must have the PORTAL_CATEGORY[DELETE] permission to use this service","operationId":"deleteCategory","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Category successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId}/background":{"get":{"tags":["Categories","Configuration"],"summary":"Get the Category's background","description":"User must have the READ permission to use this service","operationId":"getCategoryBackground","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Category's background","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId}/picture":{"get":{"tags":["Categories","Configuration"],"summary":"Get the category's picture","description":"User must have the PORTAL_CATEGORY[READ] permission to use this service","operationId":"getCategoryPicture","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Category's picture","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/dashboards":{"get":{"tags":["Dashboards","Configuration"],"summary":"Retrieve the list of platform dashboards","operationId":"getDashboards","parameters":[{"name":"reference_type","in":"query","schema":{"type":"string","enum":["PLATFORM","API","APPLICATION","HOME"]}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of platform dashboards","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DashboardEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Dashboards","Configuration"],"summary":"Create a platform dashboard","description":"User must have the MANAGEMENT_DASHBOARD[CREATE] permission to use this service","operationId":"createDashboard","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewDashboardEntity"}}},"required":true},"responses":{"201":{"description":"Dashboard successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/dashboards/{dashboardId}":{"get":{"tags":["Dashboards","Configuration"],"summary":"Retrieve a platform dashboard","description":"User must have the MANAGEMENT_DASHBOARD[READ] permission to use this service","operationId":"getDashboard","parameters":[{"name":"dashboardId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Platform dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Dashboards","Configuration"],"summary":"Update a platform dashboard","description":"User must have the MANAGEMENT_DASHBOARD[UPDATE] permission to use this service","operationId":"updateDashboard","parameters":[{"name":"dashboardId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDashboardEntity"}}},"required":true},"responses":{"200":{"description":"Updated dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Dashboards","Configuration"],"summary":"Delete a platform dashboard","description":"User must have the MANAGEMENT_DASHBOARD[DELETE] permission to use this service","operationId":"deleteDashboard","parameters":[{"name":"dashboardId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Dashboard successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/dictionaries":{"get":{"tags":["Configuration","Dictionaries"],"summary":"Get the list of global dictionaries","description":"User must have the DICTIONARY[READ] permission to use this service","operationId":"getDictionaries","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List global dictionaries","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DictionaryListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Configuration","Dictionaries"],"summary":"Create a dictionary","description":"User must have the DICTIONARY[CREATE] permission to use this service","operationId":"createDictionary","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewDictionaryEntity"}}},"required":true},"responses":{"201":{"description":"Dictionary successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/dictionaries/{dictionary}":{"get":{"tags":["Configuration","Dictionaries"],"summary":"Get a dictionary","description":"User must have the DICTIONARY[READ] permission to use this service","operationId":"getDictionary","parameters":[{"name":"dictionary","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A dictionary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Configuration","Dictionaries"],"summary":"Update a dictionary","description":"User must have the DICTIONARY[UPDATE] permission to use this service","operationId":"updateDictionary","parameters":[{"name":"dictionary","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDictionaryEntity"}}},"required":true},"responses":{"200":{"description":"Updated dictionary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Configuration","Dictionaries"],"summary":"Manage the dictionary's lifecycle","description":"User must have the DICTIONARY[LIFECYCLE] permission to use this service","operationId":"doLifecycleAction","parameters":[{"name":"action","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LifecycleAction"}},{"name":"dictionary","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Dictionary state updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Configuration","Dictionaries"],"summary":"Delete a dictionary","description":"User must have the DICTIONARY[DELETE] permission to use this service","operationId":"deleteDictionary","parameters":[{"name":"dictionary","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Dictionary successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/dictionaries/{dictionary}/_deploy":{"post":{"tags":["Configuration","Dictionaries"],"summary":"Deploy dictionary to API gateway","description":"User must have the DICTIONARY[UPDATE] permission to use this service","operationId":"deployDictionary","parameters":[{"name":"dictionary","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Dictionary successfully deployed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/dictionaries/{dictionary}/_undeploy":{"post":{"tags":["Configuration","Dictionaries"],"summary":"Undeploy dictionary to API gateway","description":"User must have the DICTIONARY[UPDATE] permission to use this service","operationId":"undeployDictionary","parameters":[{"name":"dictionary","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Dictionary successfully undeployed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/entrypoints":{"get":{"tags":["Entrypoints","Configuration"],"summary":"List the platform entrypoints","description":"User must have the MANAGEMENT_ENTRYPOINT[READ] permission to use this service","operationId":"getEntrypoints_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of platform entrypoints","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntrypointEntity"}}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Entrypoints","Configuration"],"summary":"Update a platform entrypoint","description":"User must have the MANAGEMENT_ENTRYPOINT[UPDATE] permission to use this service","operationId":"updateEntrypoint_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEntryPointEntity"}}},"required":true},"responses":{"200":{"description":"Updated entrypoint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntrypointEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Entrypoints","Configuration"],"summary":"Create a platform entrypoint","description":"User must have the MANAGEMENT_ENTRYPOINT[CREATE] permission to use this service","operationId":"createEntrypoint_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewEntryPointEntity"}}},"required":true},"responses":{"201":{"description":"Entrypoint successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntrypointEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/entrypoints/{entrypoint}":{"get":{"tags":["Entrypoints","Configuration"],"summary":"Get a platform entrypoints","description":"User must have the MANAGEMENT_ENTRYPOINT[READ] permission to use this service","operationId":"getEntrypoint_1","parameters":[{"name":"entrypoint","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A platform entrypoint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntrypointEntity"}}}},"404":{"description":"Entrypoint not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Entrypoints","Configuration"],"summary":"Delete a platform entrypoint","description":"User must have the MANAGEMENT_ENTRYPOINT[DELETE] permission to use this service","operationId":"deleteEntrypoint_1","parameters":[{"name":"entrypoint","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Entrrypoint successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/groups":{"get":{"tags":["Groups","Configuration"],"summary":"Find groups","description":"Find all groups, or a specific type of groups.Only administrators could see all groups.Only users with MANAGE_API permissions could see API groups.","operationId":"getGroups","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Groups","Configuration"],"summary":"Create group","description":"Create a new group.","operationId":"createGroup","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewGroupEntity"}}},"required":true},"responses":{"201":{"description":"Group successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupEntity"}}}},"500":{"description":"Internal Server Error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/groups/{group}":{"get":{"tags":["Groups","Configuration"],"summary":"Get a group","operationId":"getGroup","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Group definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Groups","Configuration"],"summary":"Update an existing group","operationId":"updateGroup","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroupEntity"}}},"required":true},"responses":{"200":{"description":"Group successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Groups","Configuration"],"summary":"Delete an existing group","operationId":"deleteGroup","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Group successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/groups/{group}/invitations":{"get":{"tags":["Group Invitations","Groups","Configuration"],"summary":"List existing invitations of a group","description":"User must have the GROUP_INVITATION[READ] permission to use this service","operationId":"getGroupInvitations","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvitationEntity"}}}}}}},"post":{"tags":["Group Invitations","Groups","Configuration"],"summary":"Create an invitation to join a group","description":"User must have the GROUP_INVITATION[CREATE] permission to use this service","operationId":"createGroupInvitation","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewInvitationEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/groups/{group}/invitations/{invitation}":{"put":{"tags":["Group Invitations","Groups","Configuration"],"summary":"Update an invitation to join a group","description":"User must have the GROUP_INVITATION[UPDATE] permission to use this service","operationId":"updateGroupInvitation","parameters":[{"name":"invitation","in":"path","required":true,"schema":{"type":"string"}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInvitationEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationEntity"}}}}}},"delete":{"tags":["Group Invitations","Groups","Configuration"],"summary":"Delete an invitation to join a group","description":"User must have the GROUP_INVITATION[DELETE] permission to use this service","operationId":"deleteGroupInvitation","parameters":[{"name":"invitation","in":"path","required":true,"schema":{"type":"string"}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/groups/{group}/members":{"get":{"tags":["Group Memberships","Groups","Configuration"],"summary":"List group members","operationId":"getGroupMembers","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of group's members","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupMemberEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Group Memberships","Groups","Configuration"],"summary":"Add or update a group member","operationId":"addOrUpdateGroupMember","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupMembership"}}}},"required":true},"responses":{"200":{"description":"Member has been updated"},"201":{"description":"Member has been added"},"400":{"description":"Membership is not valid"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/groups/{group}/members/_paged":{"get":{"tags":["Group Memberships","Groups","Configuration"],"summary":"List group members with pagination","operationId":"getGroupMembers_1","parameters":[{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of group's members","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupMemberEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/groups/{group}/members/{member}":{"delete":{"tags":["Group Memberships","Groups","Configuration"],"summary":"Remove a group member","operationId":"deleteGroupMember","parameters":[{"name":"member","in":"path","required":true,"schema":{"type":"string"}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Member has been removed successfully"},"400":{"description":"User does not exist"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/groups/{group}/memberships":{"get":{"tags":["Groups","Configuration"],"summary":"List APIs or applications linked to this group","operationId":"getGroupMemberships","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"tags":["Groups","Configuration"],"summary":"Associate a group to existing APIs or Applications","operationId":"addGroupMember","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Group successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/hooks":{"get":{"tags":["Configuration"],"summary":"Get the list of available hooks","operationId":"getConfigurationHooks","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Hook"}}}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/identities":{"get":{"tags":["Configuration","Identity Providers"],"summary":"Get the list of identity providers","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[READ] permission to use this service","operationId":"getIdentityProviders_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List identity providers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProviderListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Configuration","Identity Providers"],"summary":"Create an identity provider","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[CREATE] permission to use this service","operationId":"createIdentityProvider_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewIdentityProviderEntity"}}},"required":true},"responses":{"201":{"description":"Identity provider successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/identities/{identityProvider}":{"get":{"tags":["Configuration","Identity Providers"],"summary":"Get an identity provider","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[READ] permission to use this service","operationId":"getIdentityProvider_1","parameters":[{"name":"identityProvider","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"An identity provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Configuration","Identity Providers"],"summary":"Update an identity provider","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[UPDATE] permission to use this service","operationId":"updateIdentityProvider_1","parameters":[{"name":"identityProvider","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIdentityProviderEntity"}}},"required":true},"responses":{"200":{"description":"Updated identity provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Configuration","Identity Providers"],"summary":"Delete an identity provider","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER[DELETE] permission to use this service","operationId":"deleteIdentityProvider_1","parameters":[{"name":"identityProvider","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Identity provider successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/metadata":{"get":{"tags":["Metadata","Configuration"],"summary":"Retrieve the list of platform metadata","description":"User must have the PORTAL_METADATA[READ] permission to use this service","operationId":"getMetadatas","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of platform metadata","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MetadataEntity"}}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Metadata","Configuration"],"summary":"Update a platform metadata","description":"User must have the PORTAL_METADATA[UPDATE] permission to use this service","operationId":"updateMetadata","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMetadataEntity"}}},"required":true},"responses":{"200":{"description":"Updated metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Metadata","Configuration"],"summary":"Create a platform metadata","description":"User must have the PORTAL_METADATA[CREATE] permission to use this service","operationId":"createMetadata","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewMetadataEntity"}}},"required":true},"responses":{"201":{"description":"Metadata successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/metadata/{metadata}":{"delete":{"tags":["Metadata","Configuration"],"summary":"Delete a platform metadata","description":"User must have the PORTAL_METADATA[DELETE] permission to use this service","operationId":"deleteMetadata","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Metadata successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/notificationsettings":{"get":{"tags":["Portal Notifications","Configuration"],"summary":"Get notification settings","operationId":"getPortalNotificationSettings","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}},"put":{"tags":["Portal Notifications","Configuration"],"summary":"Update portal notification settings","operationId":"updatePortalNotificationSettings","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalNotificationConfigEntity"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalNotificationConfigEntity"}}}}}},"post":{"tags":["Portal Notifications","Configuration"],"summary":"Create notification settings","operationId":"createPortalNotificationSetting","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericNotificationConfigEntity"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/notificationsettings/{notificationId}":{"put":{"tags":["Portal Notifications","Configuration"],"summary":"Update generic notification settings","operationId":"updateGenericNotificationSettings","parameters":[{"name":"notificationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericNotificationConfigEntity"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericNotificationConfigEntity"}}}}}},"delete":{"tags":["Portal Notifications","Configuration"],"summary":"Delete notification settings","operationId":"deleteNotificationSettings","parameters":[{"name":"notificationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/notifiers":{"get":{"tags":["Configuration"],"summary":"List of available notifiers","operationId":"getPortalNotifiers","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of notifiers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotifierEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/plans":{"get":{"tags":["Plans","Configuration"],"summary":"List of available plan's type","operationId":"getPlansConfiguration","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of plans","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlansConfigurationEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/quality-rules":{"get":{"tags":["Configuration"],"summary":"List quality rules","operationId":"getQualityRules","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of quality rules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QualityRuleEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Configuration"],"summary":"Create a quality rule","description":"User must have the MANAGEMENT_QUALITY_RULE[CREATE] permission to use this service","operationId":"createQualityRule","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewQualityRuleEntity"}}},"required":true},"responses":{"200":{"description":"Quality rule successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualityRuleEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/quality-rules/{id}":{"get":{"tags":["Configuration"],"summary":"Get a quality rule","description":"User must have the MANAGEMENT_QUALITY_RULE[READ] permission to use this service","operationId":"getQualityRule","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Quality rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualityRuleEntity"}}}},"404":{"description":"Quality rule not found"},"500":{"description":"Internal server error"}}},"put":{"tags":["Configuration"],"summary":"Update a quality rule","description":"User must have the MANAGEMENT_QUALITY_RULE[READ] permission to use this service","operationId":"updateQualityRule","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQualityRuleEntity"}}},"required":true},"responses":{"200":{"description":"Quality rule successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualityRuleEntity"}}}},"404":{"description":"Quality rule not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Configuration"],"summary":"Delete a quality rule","description":"User must have the MANAGEMENT_QUALITY_RULE[READ] permission to use this service","operationId":"deleteQualityRule","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"Quality rule successfully deleted"},"404":{"description":"Quality rule not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/rolescopes":{"get":{"tags":["Roles","Configuration"],"summary":"List availables role scopes","operationId":"getRoleScopes_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of role scopes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleScopesLinkedHashMap"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/rolescopes/{scope}/roles":{"get":{"tags":["Roles","Configuration"],"summary":"List of roles","description":"User must have the MANAGEMENT_ROLE[READ] permission to use this service","operationId":"getRoles_1","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Role successfully removed","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RoleEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Roles","Configuration"],"summary":"Create a role","description":"User must have the MANAGEMENT_ROLE[CREATE] permission to use this service","operationId":"createRole_1","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewRoleEntity"}}},"required":true},"responses":{"200":{"description":"Role successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/rolescopes/{scope}/roles/{role}":{"get":{"tags":["Roles","Configuration"],"summary":"Get a role","description":"User must have the MANAGEMENT_ROLE[READ] permission to use this service","operationId":"getRole_1","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleEntity"}}}},"404":{"description":"Role not found"},"500":{"description":"Internal server error"}}},"put":{"tags":["Roles","Configuration"],"summary":"Update a role","description":"User must have the MANAGEMENT_ROLE[UPDATE] permission to use this service","operationId":"updateRole_1","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRoleEntity"}}},"required":true},"responses":{"200":{"description":"Role successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleEntity"}}}},"404":{"description":"Role not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Roles","Configuration"],"summary":"Delete a role","description":"User must have the MANAGEMENT_ROLE[DELETE] permission to use this service","operationId":"deleteRole_1","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Role successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleEntity"}}}},"404":{"description":"Role not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/rolescopes/{scope}/roles/{role}/users":{"get":{"tags":["Roles","Configuration"],"summary":"List users with the given role","description":"User must have the MANAGEMENT_ROLE[READ] permission to use this service","operationId":"getUsersPerRole_1","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"List of user's memberships","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MembershipListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Roles","Configuration"],"summary":"Add or update a role for a user","description":"User must have the MANAGEMENT_ROLE[CREATE] and MANAGEMENT_ROLE[UPDATE] permission to use this service","operationId":"addRoleToUser_1","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleMembership"}}},"required":true},"responses":{"201":{"description":"Membership successfully created / updated"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/rolescopes/{scope}/roles/{role}/users/{userId}":{"delete":{"tags":["Roles","Configuration"],"summary":"Delete the role for a given user","description":"User must have the MANAGEMENT_ROLE[DELETE] permission to use this service","operationId":"deleteRoleForUser_1","parameters":[{"name":"scope","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RoleScope"}},{"name":"role","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Role successfully removed"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/spel/grammar":{"get":{"tags":["Configuration"],"operationId":"getGrammar","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/tags":{"get":{"tags":["Sharding Tags","Configuration"],"summary":"List sharding tags","operationId":"getTags_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of sharding tags","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TagEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Sharding Tags","Configuration"],"summary":"Create a sharding tag","description":"User must have the MANAGEMENT_TAG[CREATE] permission to use this service","operationId":"createTag_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTagEntity"}}},"required":true},"responses":{"201":{"description":"A new sharding tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/tags/{tag}":{"get":{"tags":["Sharding Tags","Configuration"],"summary":"Get a sharding tag","description":"User must have the MANAGEMENT_TAG[READ] permission to use this service","operationId":"getTag_1","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Sharding Tags","Configuration"],"summary":"Update an existing sharding tag","description":"User must have the MANAGEMENT_TAG[UPDATE] permission to use this service","operationId":"updateTag_1","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTagEntity"}}},"required":true},"responses":{"200":{"description":"Sharding tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Sharding Tags","Configuration"],"summary":"Delete an existing sharding tag","description":"User must have the MANAGEMENT_TAG[DELETE] permission to use this service","operationId":"deleteTag_1","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Sharding tag successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/tenants":{"get":{"tags":["Tenants","Configuration"],"summary":"List tenants","operationId":"getTenants_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of tenants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantEntity"}}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Tenants","Configuration"],"summary":"Update a tenant","description":"User must have the MANAGEMENT_TENANT[UPDATE] permission to use this service","operationId":"updateTenants_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateTenantEntity"}}}},"required":true},"responses":{"200":{"description":"List of tenants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Tenants","Configuration"],"summary":"Create a tenant","description":"User must have the MANAGEMENT_TENANT[CREATE] permission to use this service","operationId":"createTenants_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewTenantEntity"}}}},"required":true},"responses":{"200":{"description":"List of tenants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/tenants/{tenant}":{"delete":{"tags":["Tenants","Configuration"],"summary":"Delete a tenant","description":"User must have the MANAGEMENT_TENANT[DELETE] permission to use this service","operationId":"deleteTenant_1","parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of tenants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/themes":{"post":{"tags":["Themes","Configuration"],"operationId":"createTheme","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewThemeEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/themes/{themeId}":{"get":{"tags":["Themes","Configuration"],"operationId":"getTheme","parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeEntity"}}}}}},"put":{"tags":["Themes","Configuration"],"operationId":"updateTheme","parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThemeEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeEntity"}}}}}},"delete":{"tags":["Themes","Configuration"],"operationId":"deleteTheme","parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/themes/{themeId}/backgroundImage":{"get":{"tags":["Themes","Configuration"],"operationId":"getThemeBackground","parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/themes/{themeId}/favicon":{"get":{"tags":["Themes","Configuration"],"operationId":"getFavicon","parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/themes/{themeId}/logo":{"get":{"tags":["Themes","Configuration"],"operationId":"getThemeLogo","parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/themes/{themeId}/optionalLogo":{"get":{"tags":["Themes","Configuration"],"operationId":"getLogoLight","parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/themes/{themeId}/reset":{"post":{"tags":["Themes","Configuration"],"operationId":"resetTheme","parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/configuration/top-apis":{"get":{"tags":["Top APIs","Configuration"],"summary":"List of top APIs","description":"User must have the PORTAL_TOP_APIS[READ] permission to use this service","operationId":"getTopApis","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of top APIs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TopApiEntity"}}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Top APIs","Configuration"],"summary":"Update a top API","description":"User must have the PORTAL_TOP_APIS[UPDATE] permission to use this service","operationId":"updateTopApi","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateTopApiEntity"}}}},"required":true},"responses":{"200":{"description":"List of top APIs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TopApiEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Top APIs","Configuration"],"summary":"Create a top API","description":"User must have the PORTAL_TOP_APIS[CREATE] permission to use this service","operationId":"createTopApi","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTopApiEntity"}}},"required":true},"responses":{"200":{"description":"List of top APIs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TopApiEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/configuration/top-apis/{topAPI}":{"delete":{"tags":["Top APIs","Configuration"],"summary":"Delete an existing top API","description":"User must have the PORTAL_TOP_APIS[DELETE] permission to use this service","operationId":"deleteTopApi","parameters":[{"name":"topAPI","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Top API successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/connectors":{"get":{"tags":["Plugins"],"summary":"List connector plugins","description":"User must have the ENVIRONMENT_API[READ] permission to use this service","operationId":"getConnectors","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of connectors","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectorListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/connectors/{connector}":{"get":{"tags":["Plugins"],"summary":"Get a connector","description":"User must have the ENVIRONMENT_API[READ] permission to use this service","operationId":"getConnector","parameters":[{"name":"connector","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Connector plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPluginEntity"}}}},"404":{"description":"Connector not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/connectors/{connector}/documentation":{"get":{"tags":["Plugins"],"summary":"Get a connector's documentation","description":"User must have the ENVIRONMENT_API[READ] permission to use this service","operationId":"getConnectorDoc","parameters":[{"name":"connector","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Connector documentation","content":{"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"Connector not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/connectors/{connector}/schema":{"get":{"tags":["Plugins"],"summary":"Get a connector's schema","description":"User must have the ENVIRONMENT_API[READ] permission to use this service","operationId":"getConnectorSchema","parameters":[{"name":"connector","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Connector schema","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Connector not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/entrypoints":{"get":{"tags":["Portal entrypoints"],"operationId":"getPortalEntrypoints","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntrypointEntity"}}}}}}}},"/organizations/{orgId}/environments/{envId}/fetchers":{"get":{"tags":["Plugins"],"summary":"List of fetcher plugins","operationId":"getFetchers","parameters":[{"name":"expand","in":"query","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"import","in":"query","schema":{"type":"boolean"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of fetchers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FetcherListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/fetchers/{fetcher}":{"get":{"tags":["Plugins"],"summary":"Get a fetcher plugin","operationId":"getFetcher","parameters":[{"name":"fetcher","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Fetcher","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetcherEntity"}}}},"404":{"description":"Fetcher not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/fetchers/{fetcher}/schema":{"get":{"tags":["Plugins"],"summary":"Get a fetcher plugin's schema","operationId":"getFetcherSchema","parameters":[{"name":"fetcher","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Fetcher's schema","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Fetcher not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/identities":{"get":{"summary":"Get the list of identity provider activations for current environment","description":"User must have the ENVIRONMENT_IDENTITY_PROVIDER_ACTIVATION[READ] permission to use this service","operationId":"getIdentityProviderActivations","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List identity provider activations for current environment","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProviderActivationEntity"}}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Environment"],"summary":"Update available environment identities","operationId":"updateEnvironmentIdentities","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProviderActivationEntity"}}}}},"responses":{"204":{"description":"Environment successfully updated"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/instances":{"get":{"tags":["Gateway"],"summary":"List gateway instances","operationId":"getInstances","parameters":[{"name":"includeStopped","in":"query","schema":{"type":"boolean","default":false}},{"name":"from","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"to","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageInstanceListItem"}}}}}}},"/organizations/{orgId}/environments/{envId}/instances/{instance}":{"get":{"tags":["Gateway"],"summary":"Get a gateway instance","operationId":"getInstance","parameters":[{"name":"instance","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/instances/{instance}/monitoring/{gatewayId}":{"get":{"tags":["Gateway"],"summary":"Get monitoring metrics for a gateway instance","operationId":"getInstanceMonitoring","parameters":[{"name":"gatewayId","in":"path","required":true,"schema":{"type":"string"}},{"name":"instance","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringData"}}}}}}},"/organizations/{orgId}/environments/{envId}/messages":{"post":{"tags":["Messages"],"summary":"Send a message to users depending on their profile","description":"User must have the MANAGEMENT_MESSAGE[CREATE] permission to use this service","operationId":"createMessage","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageEntity"}}}},"responses":{"200":{"description":"Message successfully sent","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/notifiers":{"get":{"tags":["Plugins"],"summary":"List notifier plugins","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getNotifiers","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of notifiers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotifierListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/notifiers/{notifier}":{"get":{"tags":["Plugins"],"summary":"Get a notifier","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getNotifier","parameters":[{"name":"notifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Notifier plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotifierEntity"}}}},"404":{"description":"Notifier not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/notifiers/{notifier}/schema":{"get":{"tags":["Plugins"],"summary":"Get a notifier's schema","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getNotifierSchema","parameters":[{"name":"notifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Notifier's schema","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Notifier not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/permissions":{"get":{"summary":"Get permissions on environment","operationId":"getEnvironmentPermissions","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Current user permissions on environement","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionMap"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/alerts":{"get":{"tags":["Platform Alerts","Platform"],"summary":"List configured alerts of the platform","description":"User must have the MANAGEMENT_ALERT[READ] permission to use this service","operationId":"getPlatformAlerts","parameters":[{"name":"event_counts","in":"query","schema":{"type":"boolean","default":true}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of alerts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Platform Alerts","Platform"],"summary":"Create an alert for the platform","description":"User must have the MANAGEMENT_ALERT[CREATE] permission to use this service","operationId":"createPlatformAlert","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewAlertTriggerEntity"}}},"required":true},"responses":{"200":{"description":"Alert successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/alerts/analytics":{"get":{"tags":["Platform Alerts","Platform"],"summary":"List configured alerts of the platform","description":"User must have the MANAGEMENT_ALERT[READ] permission to use this service","operationId":"getPlatformAlertsAnalytics_1","parameters":[{"name":"from","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"to","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of alerts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/alerts/status":{"get":{"tags":["Platform Alerts","Platform"],"summary":"Get alerting status","description":"User must have the MANAGEMENT_ALERT[READ] permission to use this service","operationId":"getPlatformAlertStatus","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Alerting status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertStatusEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/alerts/{alert}":{"put":{"tags":["Platform Alerts","Platform"],"summary":"Update an alert for the platform","description":"User must have the MANAGEMENT_ALERT[UPDATE] permission to use this service","operationId":"updatePlatformAlert","parameters":[{"name":"alert","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAlertTriggerEntity"}}},"required":true},"responses":{"200":{"description":"Alert successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTriggerEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Platform Alerts","Platform"],"summary":"Associate the alert to multiple references (API, APPLICATION","description":"User must have the MANAGEMENT_ALERT[UPDATE] permission to use this service","operationId":"associatePlatformAlert","parameters":[{"name":"alert","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Alert successfully associated"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Platform Alerts","Platform"],"summary":"Delete an alert for the platform","description":"User must have the MANAGEMENT_ALERT[DELETE] permission to use this service","operationId":"deletePlatformAlert","parameters":[{"name":"alert","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Alert successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/alerts/{alert}/events":{"get":{"tags":["Platform Alerts","Platform"],"summary":"Retrieve the list of events for an alert","description":"User must have the MANAGEMENT_ALERT[READ] permission to use this service","operationId":"getPlatformAlertEvents","parameters":[{"name":"alert","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"to","in":"query","schema":{"type":"integer","format":"int64","default":0}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of events","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertEventPage"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/analytics":{"get":{"tags":["Platform Analytics","Platform"],"summary":"Get platform analytics","description":"User must have the MANAGEMENT_PLATFORM[READ] permission to use this service","operationId":"getPlatformAnalytics_1","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"interval","in":"query","description":"The time interval when getting histogram data (in milliseconds)","schema":{"type":"integer","format":"int64"},"example":600000},{"name":"query","in":"query","description":"The Lucene query used to filter data","schema":{"type":"string"},"example":"api:xxxx-xxxx-xxxx-xxxx AND plan:yyyy-yyyy-yyyy-yyyy AND host:\"demo.gravitee.io\" AND path:/test"},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32"}},{"name":"type","in":"query","description":"The type of data to retrieve","required":true,"schema":{"$ref":"#/components/schemas/AnalyticsType"}},{"name":"ranges","in":"query","description":"Ranges allows you to group field's data. Mainly used to group HTTP statuses code with `group_by` queries","explode":false,"schema":{"type":"array","items":{"type":"string"}},"example":"100:199,200:299,300:399,400:499,500:599"},{"name":"aggs","in":"query","description":"Aggregations are used when doing `date_histo` queries and allows you to group field's data. Mainly used to group HTTP statuses code","explode":false,"schema":{"type":"array","items":{"type":"string"}},"example":"avg:response-time,avg:api-response-time"},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Platform analytics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Analytics"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/events":{"get":{"tags":["Platform Events","Platform"],"summary":"List platform events","description":"User must have the MANAGEMENT_PLATFORM[READ] permission to use this service","operationId":"getPlatformEvents","parameters":[{"name":"type","in":"query","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/EventType"}}},{"name":"from","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"api_ids","in":"query","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Platform events","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventEntityPage"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/logs":{"get":{"tags":["Platform Logs","Platform"],"summary":"Get platform logs","description":"User must have the MANAGEMENT_PLATFORM[READ] permission to use this service","operationId":"getPlatformLogs","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"The expresion used to search for logs. It looks like 'transaction:123-456-789 AND uri=\\\\/path\\\\/to\\\\/resource* AND response-time:[100 TO 200]'. Reserved characters that must be escaped + - = && \|\| > < ! ( ) { } [ ] ^ \" ~ * ? : \\ /","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"order","in":"query","description":"true means ASC order, false means DESC","schema":{"type":"boolean"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Platform logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformRequestItemSearchLogResponse"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/logs/export":{"get":{"tags":["Platform Logs","Platform"],"summary":"Export platform logs as CSV","description":"User must have the MANAGEMENT_PLATFORM[READ] permission to use this service","operationId":"exportPlatformLogsAsCSV","parameters":[{"name":"from","in":"query","description":"Timestamp used to define the start date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","description":"Timestamp used to define the end date of the time window to query","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"The expresion used to search for logs. It looks like 'transaction:123-456-789 AND uri=\\\\/path\\\\/to\\\\/resource* AND response-time:[100 TO 200]'. Reserved characters that must be escaped + - = && \|\| > < ! ( ) { } [ ] ^ \" ~ * ? : \\ /","schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of data to retrieve","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"field","in":"query","description":"The field to query when doing `group_by` queries","schema":{"type":"string"}},{"name":"order","in":"query","description":"true means ASC order, false means DESC","schema":{"type":"boolean"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Platform logs as CSV","content":{"text/csv":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/logs/{log}":{"get":{"tags":["Platform Logs","Platform"],"summary":"Get a specific log","description":"User must have the MANAGEMENT_PLATFORM[READ] permission to use this service","operationId":"getPlatformLog","parameters":[{"name":"log","in":"path","required":true,"schema":{"type":"string"}},{"name":"timestamp","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Single log","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequest"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/tickets":{"get":{"tags":["Platform Tickets","Platform"],"summary":"Search for platform tickets written by current user","operationId":"getTickets","parameters":[{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"apiId","in":"query","description":"The api identifier used to filter tickets","schema":{"type":"string"}},{"name":"applicationId","in":"query","description":"The application identifier used to filter tickets","schema":{"type":"string"}},{"name":"order","in":"query","description":"The field used to sort results. Can be asc or desc (prefix with minus '-') ","schema":{"type":"string"},"example":"-subject"},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List platform tickets written by current user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketEntityPage"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Platform Tickets","Platform"],"summary":"Create a platform ticket","operationId":"createPlatformTicket","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTicketEntity"}}},"required":true},"responses":{"201":{"description":"Ticket succesfully created"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/platform/tickets/{ticket}":{"get":{"tags":["Platform Tickets","Platform"],"summary":"Get a specific ticket","operationId":"getTicket","parameters":[{"name":"ticket","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Get a platform ticket","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketEntity"}}}},"404":{"description":"Ticket not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/policies":{"get":{"tags":["Plugins"],"summary":"List policies","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getPolicies","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"withResource","in":"query","schema":{"type":"boolean"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyListItem"}}}}}}}},"/organizations/{orgId}/environments/{envId}/policies/swagger":{"get":{"tags":["Plugins"],"summary":"List policies which are handling Swagger / OAI definition","description":"These policies are used when importing an OAI to create an API","operationId":"getSwaggerPolicy","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyListItem"}}}}}}}},"/organizations/{orgId}/environments/{envId}/policies/{policy}":{"get":{"tags":["Plugins"],"summary":"Get a policy","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getPolicy","parameters":[{"name":"policy","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/policies/{policy}/documentation":{"get":{"tags":["Plugins"],"summary":"Get a policy's documentation","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getPolicyDoc","parameters":[{"name":"policy","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/organizations/{orgId}/environments/{envId}/policies/{policy}/icon":{"get":{"tags":["Plugins"],"summary":"Get a policy's icon","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getPolicyIcon","parameters":[{"name":"policy","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/organizations/{orgId}/environments/{envId}/policies/{policy}/schema":{"get":{"tags":["Plugins"],"summary":"Get a policy's schema","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getPolicySchema","parameters":[{"name":"policy","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/organizations/{orgId}/environments/{envId}/portal":{"get":{"tags":["Portal"],"summary":"Get the portal configuration","description":"Every users can use this service","operationId":"getPortalConfig","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Portal configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalConfigEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Portal"],"summary":"Save the portal configuration","operationId":"savePortalConfig","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSettingsEntity"}}},"required":true},"responses":{"200":{"description":"Updated portal configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSettingsEntity"}}}},"500":{"description":"Internal server error"}},"deprecated":true}},"/organizations/{orgId}/environments/{envId}/portal/apis/_search":{"post":{"tags":["Portal APIs","Portal"],"summary":"Search for API using the search engine","operationId":"searchPortalApis","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List accessible APIs for current user","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/identities":{"get":{"tags":["Portal","Authentication","Identity Providers"],"summary":"Get the list of social identity providers","operationId":"getSocialIdentityProviders","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List social identity providers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialIdentityProviderEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/media/upload":{"post":{"tags":["Portal Media","Portal"],"summary":"Create a media for the portal","description":"User must have the PORTAL_DOCUMENTATION[CREATE] permission to use this service","operationId":"uploadPortalMedia","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/FormDataBodyPart"}}}}}},"responses":{"200":{"description":"Media successfully created","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/media/{hash}":{"get":{"tags":["Portal Media","Portal"],"summary":"Retrieve a media","operationId":"getPortalMedia","parameters":[{"name":"hash","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A media","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/pages":{"get":{"tags":["Portal Pages","Portal"],"summary":"List pages","description":"Every users can use this service","operationId":"getPortalPages","parameters":[{"name":"Accept-Language","in":"header","schema":{"type":"string"}},{"name":"homepage","in":"query","schema":{"type":"boolean"}},{"name":"published","in":"query","schema":{"type":"boolean"}},{"name":"type","in":"query","schema":{"$ref":"#/components/schemas/PageType"}},{"name":"parent","in":"query","schema":{"type":"string"}},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"root","in":"query","schema":{"type":"boolean"}},{"name":"translated","in":"query","schema":{"type":"boolean"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of pages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Portal Pages","Portal"],"summary":"Create a page","description":"User must have the ENVIRONMENT_DOCUMENTATION[CREATE] permission to use this service","operationId":"createPortalPage","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/pages/_fetch":{"post":{"tags":["Portal Pages","Portal"],"summary":"Refresh all pages by calling their associated fetcher","description":"User must have the ENVIRONMENT_DOCUMENTATION[UPDATE] permission to use this service","operationId":"fetchAllPortalPages","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"Pages successfully refreshed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/pages/_import":{"put":{"tags":["Portal Pages","Portal"],"summary":"Import pages","description":"User must have the ENVIRONMENT_DOCUMENTATION[CREATE] permission to use this service","operationId":"updateImportedPortalPageFromFiles","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportPageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Portal Pages","Portal"],"summary":"Import pages","description":"User must have the ENVIRONMENT_DOCUMENTATION[CREATE] permission to use this service","operationId":"importPortalPageFromFiles","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportPageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/pages/{page}":{"get":{"tags":["Portal Pages","Portal"],"summary":"Get a page","description":"Every users can use this service","operationId":"getPortalPage","parameters":[{"name":"Accept-Language","in":"header","schema":{"type":"string"}},{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"portal","in":"query","schema":{"type":"boolean"}},{"name":"translated","in":"query","schema":{"type":"boolean"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Portal Pages","Portal"],"summary":"Update a page","description":"User must have the ENVIRONMENT_DOCUMENTATION[UPDATE] permission to use this service","operationId":"updatePortalPage","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["Portal Pages","Portal"],"summary":"Delete a page","description":"User must have the ENVIRONMENT_DOCUMENTATION[DELETE] permission to use this service","operationId":"deletePortalPage","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Page successfully deleted"},"500":{"description":"Internal server error"}}},"patch":{"tags":["Portal Pages","Portal"],"summary":"Update a page","description":"User must have the ENVIRONMENT_DOCUMENTATION[UPDATE] permission to use this service","operationId":"partialUpdatePortalPage","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/pages/{page}/_fetch":{"post":{"tags":["Portal Pages","Portal"],"summary":"Refresh page by calling the associated fetcher","description":"User must have the ENVIRONMENT_DOCUMENTATION[UPDATE] permission to use this service","operationId":"fetchPortalPage","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"Page successfully refreshed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/pages/{page}/content":{"get":{"tags":["Portal Pages","Portal"],"summary":"Get the page's content","description":"Every users can use this service","operationId":"getPortalPageContent","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Page's content","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Portal Pages","Portal"],"summary":"Update a page content","description":"User must have the PORTAL_DOCUMENTATION[UPDATE] permission to use this service","operationId":"updatePageContent_1","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Page content successfully updated","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/portal/pages/{page}/media":{"get":{"tags":["Portal Media","Portal Pages","Portal"],"summary":"Retrieve all media for a Portal page","description":"User must have the ENVIRONMENT_DOCUMENTATION[READ] permission to use this service","operationId":"getPortalPageMedia","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"tags":["Portal Media","Portal Pages","Portal"],"summary":"Attach a media to a portal page ","description":"User must have the ENVIRONMENT_DOCUMENTATION[UPDATE] permission to use this service","operationId":"attachPortalPageMedia","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/FormDataBodyPart"},"fileName":{"type":"string"}}}}}},"responses":{"201":{"description":"Media successfully added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/promotion-targets":{"get":{"tags":["Promotion"],"summary":"List available targets (environments) for a promotion","operationId":"getPromotionTargets","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of promotion targets","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTargetEntity"}}}}},"500":{"description":"Internal server error"},"503":{"description":"Installation not connected to cockpit"}}}},"/organizations/{orgId}/environments/{envId}/resources":{"get":{"tags":["Plugins"],"summary":"List resource plugins","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getResources","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of resources","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/resources/{resource}":{"get":{"tags":["Plugins"],"summary":"Get a resource","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getResource","parameters":[{"name":"resource","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Resource plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPluginEntity"}}}},"404":{"description":"Resource not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/resources/{resource}/documentation":{"get":{"tags":["Plugins"],"summary":"Get a resource's documentation","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getResourceDoc","parameters":[{"name":"resource","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/organizations/{orgId}/environments/{envId}/resources/{resource}/schema":{"get":{"tags":["Plugins"],"summary":"Get a resource's schema","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getResourceSchema","parameters":[{"name":"resource","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/organizations/{orgId}/environments/{envId}/search/users":{"get":{"tags":["Users"],"summary":"Search for users","operationId":"searchUsers","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of users","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchableUser"}}}}},"400":{"description":"Bad query parameter"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/services-discovery":{"get":{"tags":["Plugins"],"summary":"List service discovery plugins","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getServicesDiscoverResources","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of service discovery plugins","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/services-discovery/{plugin}":{"get":{"tags":["Plugins"],"summary":"Get a service discovery","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getServiceDiscovery","parameters":[{"name":"plugin","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Service discovery plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPluginEntity"}}}},"404":{"description":"Resource not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/services-discovery/{plugin}/schema":{"get":{"tags":["Plugins"],"summary":"Get a service discovery's schema","description":"User must have the MANAGEMENT_API[READ] permission to use this service","operationId":"getServiceDiscoverySchema","parameters":[{"name":"plugin","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Service discovery plugin's schema","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Service discovery not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/settings":{"get":{"tags":["Settings"],"summary":"Get the portal settings","operationId":"getPortalSettings","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Portal configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSettingsEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Settings"],"summary":"Save the portal settings","operationId":"savePortalSettings","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSettingsEntity"}}},"required":true},"responses":{"200":{"description":"Updated portal settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSettingsEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/subscriptions":{"get":{"tags":["Subscription"],"summary":"List subscriptions for authenticated user","operationId":"getUserSubscriptions","parameters":[{"name":"application","in":"query","schema":{"type":"string"}},{"name":"plan","in":"query","schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of subscriptions","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Subscription"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/tickets":{"get":{"tags":["Platform Tickets"],"summary":"Search for platform tickets written by current user","operationId":"getTickets_1","parameters":[{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"apiId","in":"query","description":"The api identifier used to filter tickets","schema":{"type":"string"}},{"name":"applicationId","in":"query","description":"The application identifier used to filter tickets","schema":{"type":"string"}},{"name":"order","in":"query","description":"The field used to sort results. Can be asc or desc (prefix with minus '-') ","schema":{"type":"string"},"example":"-subject"},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List platform tickets written by current user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketEntityPage"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Platform Tickets"],"summary":"Create a platform ticket","operationId":"createPlatformTicket_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTicketEntity"}}},"required":true},"responses":{"201":{"description":"Ticket succesfully created"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/tickets/{ticket}":{"get":{"tags":["Platform Tickets"],"summary":"Get a specific ticket","operationId":"getTicket_1","parameters":[{"name":"ticket","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Get a platform ticket","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketEntity"}}}},"404":{"description":"Ticket not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user":{"get":{"tags":["Current User"],"summary":"Get the authenticated user","operationId":"getCurrentUser_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Authenticated user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}},"401":{"description":"Unauthorized user"},"500":{"description":"Internal server error"}}},"put":{"tags":["Current User"],"summary":"Update the authenticated user","operationId":"updateCurrentUser_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/UpdateUserEntity"}}},"required":true},"responses":{"200":{"description":"Updated user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"400":{"description":"Invalid user profile"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Current User"],"summary":"Delete the current logged user","operationId":"deleteCurrentUser_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Current user successfully deleted"},"401":{"description":"Unauthorized"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user/avatar":{"get":{"tags":["Current User"],"summary":"Get user's avatar","operationId":"getCurrentUserPicture_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's avatar","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user/login":{"post":{"tags":["Current User"],"summary":"Login","operationId":"login_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/user/logout":{"post":{"tags":["Current User"],"summary":"Logout","operationId":"logoutCurrentUser_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/user/newsletter/_subscribe":{"post":{"tags":["Newsletter","Current User"],"summary":"Subscribe to the newsletter the authenticated user","operationId":"subscribeNewsletterToCurrentUser_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Updated user","content":{"/":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"400":{"description":"Invalid user profile"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user/newsletter/taglines":{"get":{"tags":["Newsletter","Current User"],"summary":"Get taglines to display in the newsletter","operationId":"getTaglines_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Retrieved taglines","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user/notifications":{"get":{"tags":["User Notifications","Current User"],"summary":"List user's notifications","operationId":"getUserNotifications_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's notifications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalNotificationPageResult"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["User Notifications","Current User"],"summary":"Delete all user's notifications","operationId":"deleteAllUserNotifications_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Notifications successfully deleted"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user/notifications/{notification}":{"delete":{"tags":["User Notifications","Current User"],"summary":"Delete a single user's notification","operationId":"deleteUserNotification_1","parameters":[{"name":"notification","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Notification successfully deleted"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user/tags":{"get":{"tags":["Current User"],"summary":"Get the user's allowed sharding tags","operationId":"getUserShardingTags_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's sharding tags","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user/tasks":{"get":{"tags":["Current User"],"summary":"Get the user's tasks","operationId":"getUserTasks_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's tasks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEntityPagedResult"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user/tokens":{"get":{"tags":["User Tokens","Current User"],"summary":"List user's personal tokens","operationId":"getTokens_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's personal tokens","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TokenEntity"}}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"post":{"tags":["User Tokens","Current User"],"summary":"Create a personal token","operationId":"createTokens_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTokenEntity"}}},"required":true},"responses":{"201":{"description":"A new personal token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["User Tokens","Current User"],"summary":"Revoke all user's personal tokens","operationId":"revokeAllTokens_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User's personal tokens revoked"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/user/tokens/{token}":{"delete":{"tags":["User Tokens","Current User"],"summary":"Revoke a single user's personal tokens","operationId":"revokeToken_1","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User's personal token revoked"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users":{"get":{"tags":["Users"],"summary":"Search for users using the search engine","description":"User must have the ORGANIZATION_USERS[READ] permission to use this service","operationId":"getAllUsers","parameters":[{"name":"q","in":"query","schema":{"type":"string"}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List users matching the query criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPageResult"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Users"],"summary":"Create a user","description":"User must have the ORGANIZATION_USERS[CREATE] permission to use this service","operationId":"createUser","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPreRegisterUserEntity"}}}},"responses":{"200":{"description":"List users matching the query criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/registration":{"post":{"tags":["User Registration","Users"],"summary":"Register a user","description":"User registration must be enabled","operationId":"registerUser","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewExternalUserEntity"}}}},"responses":{"200":{"description":"User successfully registered","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/registration/finalize":{"post":{"tags":["User Registration","Users"],"summary":"Finalize user registration","description":"User registration must be enabled","operationId":"finalizeUserRegistration","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterUserEntity"}}}},"responses":{"200":{"description":"User successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}":{"get":{"tags":["Users"],"summary":"Retrieve a user","description":"User must have the ORGANIZATION_USERS[READ] permission to use this service","operationId":"getUser","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Users"],"summary":"Delete a user","description":"User must have the ORGANIZATION_USERS[DELETE] permission to use this service","operationId":"deleteUser","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User successfully deleted"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}/_process":{"post":{"tags":["Users"],"summary":"Process a user registration by accepting or rejecting it","operationId":"validateRegistration","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"type":"boolean"}}}},"responses":{"200":{"description":"Processed user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}/avatar":{"get":{"tags":["Users"],"summary":"Get the user's avatar","operationId":"getUserAvatar","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's avatar","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}/changePassword":{"post":{"tags":["Users"],"summary":"Change user password after a reset","description":"User registration must be enabled","operationId":"finalizeResetPassword","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ResetPasswordUserEntity"}}}},"responses":{"200":{"description":"User successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}/groups":{"get":{"tags":["Users"],"summary":"List of groups the user belongs to","description":"User must have the ORGANIZATION_USERS[READ] permission to use this service","operationId":"getUserGroups","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of user groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupEntity"}}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}/memberships":{"get":{"tags":["Users"],"summary":"List of memberships the user belongs to","description":"User must have the ORGANIZATION_USERS[READ] permission to use this service","operationId":"getUserMemberships","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of user memberships","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserMembershipList"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}/resetPassword":{"post":{"tags":["Users"],"summary":"Reset the user's password","description":"User must have the ORGANIZATION_USERS[UPDATE] permission to use this service","operationId":"resetUserPassword","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User's password reset"},"400":{"description":"reset page URL must not be null"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}/roles":{"put":{"tags":["Users"],"operationId":"updateUserRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/UserReferenceRoleEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}/tokens":{"get":{"tags":["User Tokens","Users"],"summary":"List user's personal tokens","operationId":"getUserTokens","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's personal tokens","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TokenEntity"}}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"post":{"tags":["User Tokens","Users"],"summary":"Create a personal token","operationId":"createToken","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTokenEntity"}}},"required":true},"responses":{"201":{"description":"A new personal token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/users/{userId}/tokens/{token}":{"delete":{"tags":["User Tokens","Users"],"summary":"Revoke a single user's personal tokens","operationId":"revokeToken_2","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User's personal token revoked"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis":{"post":{"tags":["🧪 V4 - APIs"],"summary":"🧪 Create an API","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have API_PUBLISHER or ADMIN role to create an API.","operationId":"createApi_1","parameters":[{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApiEntityV4"}}},"required":true},"responses":{"201":{"description":"API successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntityV4"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}":{"get":{"tags":["🧪 V4 - APIs"],"summary":"🧪 Get the API","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the READ permission on the API_DEFINITION to use this service on a private API.","operationId":"getApi_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntityV4"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["🧪 V4 - APIs"],"summary":"🧪 Update the API","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the MANAGE_API permission to use this service","operationId":"updateApi_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiEntityV4"}}},"required":true},"responses":{"200":{"description":"API successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["🧪 V4 - APIs"],"summary":"🧪 Manage the API's lifecycle","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the MANAGE_LIFECYCLE permission to use this service","operationId":"doApiLifecycleAction_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LifecycleAction"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"500":{"description":"Internal server error"}}},"delete":{"tags":["🧪 V4 - APIs"],"summary":"🧪 Delete the API","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the DELETE permission to use this service","operationId":"deleteApi_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"closePlans","in":"query","schema":{"type":"boolean"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"API successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/deploy":{"post":{"tags":["🧪 V4 - APIs"],"summary":"🧪 Deploy API to gateway instances","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the MANAGE_LIFECYCLE permission to use this service","operationId":"deployApi_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDeploymentEntity"}}}},"responses":{"200":{"description":"API successfully deployed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/events":{"get":{"tags":["API Events","🧪 V4 - APIs"],"summary":"Get API's events","description":"User must have the MANAGE_LIFECYCLE permission to use this service","operationId":"getApiEventsEvents_1","parameters":[{"name":"type","in":"query","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/EventType"}}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API's events","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/events/search":{"get":{"tags":["API Events","🧪 V4 - APIs"],"summary":"Get API's events","description":"User must have the API_EVENT[READ] permission to use this service","operationId":"searchApiEvents_1","parameters":[{"name":"type","in":"query","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/EventType"}}},{"name":"from","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"to","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"api_ids","in":"query","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Page of API events","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventEntityPage"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/events/{eventId}":{"get":{"tags":["API Events","🧪 V4 - APIs"],"summary":"Get an API event with its id","description":"User must have the READ API_EVENT permission to use this service","operationId":"getEvent_1","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/groups":{"get":{"tags":["🧪 V4 - APIs"],"summary":"Get API groups mapped to members","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"getApiGroupsWithMembers_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API groups with members","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiGroupsWithMembersMap"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/members":{"get":{"tags":["API Memberships","🧪 V4 - APIs"],"summary":"List API members","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"getApiMembers_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of API's members","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MembershipListItem"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Memberships","🧪 V4 - APIs"],"summary":"Add or update an API member","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"addOrUpdateApiMember_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ApiMembership"}}},"required":true},"responses":{"201":{"description":"Member has been added or updated successfully"},"400":{"description":"Membership parameter is not valid"},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Memberships","🧪 V4 - APIs"],"summary":"Remove an API member","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"deleteApiMember_1","parameters":[{"name":"user","in":"query","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Member has been removed successfully"},"400":{"description":"User does not exist"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/members/permissions":{"get":{"tags":["API Memberships","🧪 V4 - APIs"],"summary":"Get API members","description":"User must have the MANAGE_MEMBERS permission to use this service","operationId":"getApiMembersPermissions_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API member's permissions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MemberEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/members/transfer_ownership":{"post":{"tags":["API Memberships","🧪 V4 - APIs"],"summary":"Transfer the ownership of the API","description":"User must have the TRANSFER_OWNERSHIP permission to use this service","operationId":"transferApiMemberOwnership_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/TransferOwnership"}}},"required":true},"responses":{"200":{"description":"Ownership has been transferred successfully"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/metadata":{"get":{"tags":["API Metadata","🧪 V4 - APIs"],"summary":"List metadata for the given API","description":"User must have the API_METADATA[READ] permission to use this service","operationId":"getApiMetadatas_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of metadata","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiMetadataEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Metadata","🧪 V4 - APIs"],"summary":"Create an API metadata","description":"User must have the API_METADATA[CREATE] permission to use this service","operationId":"createApiMetadata_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApiMetadataEntity"}}},"required":true},"responses":{"201":{"description":"A new API metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMetadataEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/metadata/{metadata}":{"get":{"tags":["API Metadata","🧪 V4 - APIs"],"summary":"A metadata for the given API and metadata id","description":"User must have the API_METADATA[READ] permission to use this service","operationId":"getApiMetadata_1","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMetadataEntity"}}}},"404":{"description":"Metadata not found"},"500":{"description":"Internal server error"}}},"put":{"tags":["API Metadata","🧪 V4 - APIs"],"summary":"Update an API metadata","description":"User must have the API_METADATA[UPDATE] permission to use this service","operationId":"updateApiMetadata_1","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiMetadataEntity"}}},"required":true},"responses":{"201":{"description":"API metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMetadataEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Metadata","🧪 V4 - APIs"],"summary":"Delete a metadata","description":"User must have the API_METADATA[DELETE] permission to use this service","operationId":"deleteApiMetadata_1","parameters":[{"name":"metadata","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Metadata successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/pages":{"get":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"List pages","description":"User must have the READ permission to use this service","operationId":"getApiPages_1","parameters":[{"name":"Accept-Language","in":"header","schema":{"type":"string"}},{"name":"homepage","in":"query","schema":{"type":"boolean"}},{"name":"type","in":"query","schema":{"$ref":"#/components/schemas/PageType"}},{"name":"parent","in":"query","schema":{"type":"string"}},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"root","in":"query","schema":{"type":"boolean"}},{"name":"translated","in":"query","schema":{"type":"boolean"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of pages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageEntity"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Create a page","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"createApiPage_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/pages/_fetch":{"post":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Refresh all pages by calling their associated fetcher","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"fetchAllApiPages_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"Pages successfully refreshed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/pages/_import":{"put":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Import pages","description":"User must be ADMIN to use this service","operationId":"updateApiPageImportFiles_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportPageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Import pages","description":"User must be ADMIN to use this service","operationId":"importApiPageFiles_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportPageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/pages/{page}":{"get":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Get a page","description":"User must have the READ permission to use this service","operationId":"getApiPage_1","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept-Language","in":"header","schema":{"type":"string"}},{"name":"portal","in":"query","schema":{"type":"boolean"}},{"name":"translated","in":"query","schema":{"type":"boolean"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Update a page","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"updateApiPage_1","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePageEntity"}}},"required":true},"responses":{"201":{"description":"Page successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Delete a page","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"deleteApiPage_1","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Page successfully deleted"},"500":{"description":"Internal server error"}}},"patch":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Update a page","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"partialUpdateApiPage_1","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePageEntity"}}}},"responses":{"201":{"description":"Page successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/pages/{page}/_fetch":{"post":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Refresh page by calling the associated fetcher","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"fetchApiPage_1","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"Page successfully refreshed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/pages/{page}/content":{"get":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Get the page's content","description":"User must have the READ permission to use this service","operationId":"getApiPageContent_1","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Page's content","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["API Pages","🧪 V4 - APIs"],"summary":"Put the page's content","description":"User must have the MANAGE_PAGES permission to use this service","operationId":"updatePageContent_2","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"201":{"description":"Page content successfully updated"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/pages/{page}/media":{"get":{"tags":["API Media","API Pages","🧪 V4 - APIs"],"summary":"Retrieve all media for an API page","description":"User must have the API_DOCUMENTATION[READ] permission to use this service","operationId":"getApiPageMedia_1","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"tags":["API Media","API Pages","🧪 V4 - APIs"],"summary":"Attach a media to an API page ","description":"User must have the API_DOCUMENTATION[UPDATE] permission to use this service","operationId":"attachApiPageMedia_1","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/FormDataBodyPart"},"fileName":{"type":"string"}}}}}},"responses":{"201":{"description":"Media successfully added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/plans":{"get":{"tags":["🧪 V4 - API Plans","🧪 V4 - APIs"],"summary":"🧪 List plans for an API","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>List all the plans accessible to the current user.","operationId":"getApiPlans_1","parameters":[{"name":"status","in":"query","explode":false,"schema":{"type":"array","items":{"type":"string","default":"PUBLISHED","enum":["STAGING","PUBLISHED","DEPRECATED","CLOSED"]}}},{"name":"security","in":"query","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlanSecurityTypeV4"}}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List accessible plans for current user","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PlanEntityV4"}}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["🧪 V4 - API Plans","🧪 V4 - APIs"],"summary":"🧪 Create a plan","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the MANAGE_PLANS permission to use this service","operationId":"createApiPlan_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPlanEntityV4"}}},"required":true},"responses":{"201":{"description":"Plan successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntityV4"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/plans/{plan}":{"get":{"tags":["🧪 V4 - API Plans","🧪 V4 - APIs"],"summary":"🧪 Get a plan","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the READ permission to use this service","operationId":"getApiPlan_1","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Plan information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntityV4"}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["🧪 V4 - API Plans","🧪 V4 - APIs"],"summary":"🧪 Update a plan","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the MANAGE_PLANS permission to use this service","operationId":"updateApiPlan_1","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlanEntityV4"}}},"required":true},"responses":{"200":{"description":"Plan successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntityV4"}}}},"400":{"description":"Bad plan format"},"500":{"description":"Internal server error"}}},"delete":{"tags":["🧪 V4 - API Plans","🧪 V4 - APIs"],"summary":"🧪 Delete a plan","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the MANAGE_PLANS permission to use this service","operationId":"deleteApiPlan_1","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully deleted"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/plans/{plan}/_close":{"post":{"tags":["🧪 V4 - API Plans","🧪 V4 - APIs"],"summary":"🧪 Close a plan","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the MANAGE_PLANS permission to use this service","operationId":"closeApiPlan_1","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully closed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntityV4"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/plans/{plan}/_deprecate":{"post":{"tags":["🧪 V4 - API Plans","🧪 V4 - APIs"],"summary":"🧪 Deprecate a plan","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the API_PLAN[UPDATE] permission to use this service","operationId":"deprecateApiPlan_1","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully deprecated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntityV4"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/plans/{plan}/_depreciate":{"post":{"tags":["🧪 V4 - API Plans","🧪 V4 - APIs"],"summary":"🧪 Deprecated, use '_deprecate' instead. Deprecate a plan","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the API_PLAN[UPDATE] permission to use this service","operationId":"depreciateApiPlan_1","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully deprecated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntityV4"}}}},"500":{"description":"Internal server error"}},"deprecated":true}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/plans/{plan}/_publish":{"post":{"tags":["🧪 V4 - API Plans","🧪 V4 - APIs"],"summary":"🧪 Publicly publish plan","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the MANAGE_PLANS permission to use this service","operationId":"publishApiPlan_1","parameters":[{"name":"plan","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Plan successfully published","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEntityV4"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings":{"get":{"tags":["API Ratings","🧪 V4 - APIs"],"summary":"List ratings for an API","operationId":"getApiRating_1","parameters":[{"name":"pageNumber","in":"query","schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRatingEntity"}}}}}},"post":{"tags":["API Ratings","🧪 V4 - APIs"],"summary":"Create a new rating for an API","description":"User must have the API_RATING[CREATE] permission to use this service","operationId":"createApiRating_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewRatingEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/current":{"get":{"tags":["API Ratings","🧪 V4 - APIs"],"summary":"Retrieve current rating for an API provided by the authenticated user","operationId":"getApiRatingByApiAndUser_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/summary":{"get":{"tags":["API Ratings","🧪 V4 - APIs"],"summary":"Get the rating summary for an API","operationId":"getApiRatingSummaryByApi_1","parameters":[{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingSummaryEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating}":{"put":{"tags":["API Ratings","🧪 V4 - APIs"],"summary":"Update an existing rating for an API","description":"User must have the API_RATING[UPDATE] permission to use this service","operationId":"updateApiRating_1","parameters":[{"name":"rating","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRatingEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingEntity"}}}}}},"delete":{"tags":["API Ratings","🧪 V4 - APIs"],"summary":"Delete an existing rating for an API","description":"User must have the API_RATING[DELETE] permission to use this service","operationId":"deleteApiRating_1","parameters":[{"name":"rating","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating}/answers":{"post":{"tags":["API Ratings","🧪 V4 - APIs"],"summary":"Create an answer to a rating for an API","description":"User must have the API_RATING_ANSWER[CREATE] permission to use this service","operationId":"createApiRatingAnswer_1","parameters":[{"name":"rating","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewRatingAnswerEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingEntity"}}}}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating}/answers/{answer}":{"delete":{"tags":["API Ratings","🧪 V4 - APIs"],"summary":"Delete an answer to a rating for an API","description":"User must have the API_RATING_ANSWER[DELETE] permission to use this service","operationId":"deleteApiRatingAnswer_1","parameters":[{"name":"rating","in":"path","required":true,"schema":{"type":"string"}},{"name":"answer","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscribers":{"get":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"List subscribers for the API","description":"User must have the MANAGE_SUBSCRIPTIONS permission to use this service","operationId":"getApiSubscribers_1","parameters":[{"name":"query","in":"query","schema":{"type":"string"}},{"name":"exclude","in":"query","schema":{"type":"array","items":{"type":"string","enum":["PICTURE","OWNER"]}}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Paged result of API subscribers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions":{"get":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"List subscriptions for the API","description":"User must have the READ_SUBSCRIPTION permission to use this service","operationId":"getApiSubscriptions_1","parameters":[{"name":"plan","in":"query","description":"plan","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"application","in":"query","description":"application","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"status","in":"query","description":"Comma separated list of Subscription status, default is ACCEPTED","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionStatus"}}},{"name":"api_key","in":"query","schema":{"type":"string"}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"expand","in":"query","description":"Expansion of data to return in subscriptions","schema":{"type":"array","items":{"type":"string","enum":["keys","security"]}}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Paged result of API's subscriptions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntityPageResult"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"Subscribe to a plan","description":"User must have the MANAGE_SUBSCRIPTIONS permission to use this service","operationId":"createSubscriptionToApi_1","parameters":[{"name":"application","in":"query","required":true,"schema":{"type":"string"}},{"name":"plan","in":"query","required":true,"schema":{"type":"string"}},{"name":"customApiKey","in":"query","schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSubscriptionConfigurationEntity"}}}},"responses":{"201":{"description":"Subscription successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Bad custom API Key format or custom API Key definition disabled"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/_canCreate":{"get":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"Check a subscription can be created with given api key, and application","description":"User must have the API_SUBSCRIPTION:READ permission to use this service","operationId":"verifyApiKeyCreation_1","parameters":[{"name":"key","in":"query","required":true,"schema":{"type":"string"}},{"name":"application","in":"query","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API Key creation successfully checked","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Bad API Key parameter"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/export":{"get":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"Export API logs as CSV","operationId":"exportApiSubscriptionsLogsAsCSV_1","parameters":[{"name":"plan","in":"query","description":"plan","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"application","in":"query","description":"application","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"status","in":"query","description":"Comma separated list of Subscription status, default is ACCEPTED","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionStatus"}}},{"name":"api_key","in":"query","schema":{"type":"string"}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"API logs as CSV","content":{"text/csv":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/{subscription}":{"get":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"Get a subscription","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"getApiSubscription_1","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Get a subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"404":{"description":"Subscription does not exist"},"500":{"description":"Internal server error"}}},"put":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"Update a subscription","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"updateApiSubscription_1","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionEntity"}}},"required":true},"responses":{"200":{"description":"Update a subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Bad subscription format"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/{subscription}/_process":{"post":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"Update a subscription","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"processApiSubscription_1","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ProcessSubscriptionEntity"}}},"required":true},"responses":{"200":{"description":"Update a subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Bad subscription format"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/{subscription}/_transfer":{"post":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"Transfer a subscription","description":"User must have the API_SUBSCRIPTION update permission to use this service","operationId":"transferApiSubscription_1","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/TransferSubscriptionEntity"}}},"required":true},"responses":{"200":{"description":"Update a subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Bad subscription format"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/{subscription}/apikeys":{"get":{"tags":["API Keys","API Subscriptions","🧪 V4 - APIs"],"summary":"List all API Keys for a subscription","description":"User must have the MANAGE_API_KEYS permission to use this service","operationId":"getApiKeysForApiSubscription_1","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of API Keys for a subscription","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/{subscription}/apikeys/_renew":{"post":{"tags":["API Keys","API Subscriptions","🧪 V4 - APIs"],"summary":"Renew an API key","description":"User must have the MANAGE_API_KEYS permission to use this service","operationId":"renewSubscriptionApiKeysForApiSubscription_1","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"customApiKey","in":"query","schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"201":{"description":"A new API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}}},"400":{"description":"Bad custom API Key format or custom API Key definition disabled"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/{subscription}/apikeys/{apikey}":{"put":{"tags":["API Keys","API Subscriptions","🧪 V4 - APIs"],"summary":"Update API Key","description":"User must have the API_SUBSCRIPTION:UPDATE permission to use this service","operationId":"updateApiKeyForApiSubscription_1","parameters":[{"name":"apikey","in":"path","required":true,"schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}},"required":true},"responses":{"200":{"description":"API Key successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}}},"400":{"description":"Bad API Key key format"},"500":{"description":"Internal server error"}}},"delete":{"tags":["API Keys","API Subscriptions","🧪 V4 - APIs"],"summary":"Revoke API key","description":"User must have the API_SUBSCRIPTION:DELETE permission to use this service","operationId":"revokeApiKeyForApiSubscription_1","parameters":[{"name":"apikey","in":"path","required":true,"schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/{subscription}/apikeys/{apikey}/_reactivate":{"post":{"tags":["API Keys","API Subscriptions","🧪 V4 - APIs"],"summary":"Reactivate an API key","description":"User must have the API_SUBSCRIPTION permission to use this service","operationId":"reactivateApiKeyForApiSubscription_1","parameters":[{"name":"apikey","in":"path","required":true,"schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"API key successfully reactivated"},"400":{"description":"API Key does not correspond to the subscription"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/apis/{api}/subscriptions/{subscription}/status":{"post":{"tags":["API Subscriptions","🧪 V4 - APIs"],"summary":"Change the status of a subscription","description":"User must have the MANAGE_PLANS permission to use this service","operationId":"changeApiSubscriptionStatus_1","parameters":[{"name":"subscription","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SubscriptionStatus"}},{"name":"api","in":"path","description":"The ID of the API","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Subscription status successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Status changes not authorized"},"404":{"description":"API subscription does not exist"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/entrypoints":{"get":{"tags":["🧪 V4 - Plugins"],"summary":"🧪 List entrypoint plugins","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the ENVIRONMENT_API[READ] permission to use this service","operationId":"getEntrypoint_2","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of entrypoints","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectorListItem"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/entrypoints/{entrypoint}":{"get":{"tags":["🧪 V4 - Plugins"],"summary":"🧪 Get an entrypoint","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the ENVIRONMENT_API[READ] permission to use this service","operationId":"getEntrypoint_3","parameters":[{"name":"entrypoint","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Entrypoint plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPluginEntity"}}}},"404":{"description":"Entrypoint not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/entrypoints/{entrypoint}/documentation":{"get":{"tags":["🧪 V4 - Plugins"],"summary":"🧪 Get a entrypoint's documentation","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the ENVIRONMENT_API[READ] permission to use this service","operationId":"getEntrypointDoc","parameters":[{"name":"entrypoint","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Entrypoint documentation","content":{"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"Entrypoint not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/environments/{envId}/v4/entrypoints/{entrypoint}/schema":{"get":{"tags":["🧪 V4 - Plugins"],"summary":"🧪 Get a entrypoint's schema","description":"⚠️ This resource is in alpha version. This implies that it is likely to be modified or even removed in future versions. ⚠️. <br><br>User must have the ENVIRONMENT_API[READ] permission to use this service","operationId":"getEntrypointSchema","parameters":[{"name":"entrypoint","in":"path","required":true,"schema":{"type":"string"}},{"name":"envId","in":"path","description":"The ID of the environment","required":true,"schema":{"type":"string","default":"DEFAULT"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Entrypoint schema","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Entrypoint not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/groups":{"get":{"tags":["Organization Groups"],"summary":"Find groups","description":"Find all groups for current organizationOnly users with ORGANIZATION_TAG permissions could see API groups.","operationId":"getGroups_1","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupSimpleEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/identities":{"get":{"summary":"Get the list of identity provider activations for current organization","description":"User must have the ORGANIZATION_IDENTITY_PROVIDER_ACTIVATION[READ] permission to use this service","operationId":"listIdentityProviderActivations","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List identity provider activations for current organization","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProviderActivationEntity"}}}}},"500":{"description":"Internal server error"}}},"put":{"tags":["Organization"],"summary":"Update available organization identities","operationId":"updateOrganizationIdentities","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/IdentityProviderActivationEntity"}}}}},"responses":{"204":{"description":"Organization successfully updated"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/promotions/_search":{"post":{"tags":["Promotions"],"summary":"Search for Promotion","operationId":"searchPromotions","parameters":[{"name":"statuses","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"apiId","in":"query","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List promotions matching request parameters","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PromotionEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/promotions/{promotion}/_process":{"post":{"tags":["Promotion","Promotions"],"summary":"Process an API promotion by accepting or rejecting it","operationId":"processPromotion","parameters":[{"name":"promotion","in":"path","description":"The ID of the promotion","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"type":"boolean"}}}},"responses":{"200":{"description":"Processed promotion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionEntity"}}}},"404":{"description":"Promotion not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/search/users":{"get":{"tags":["Users"],"summary":"Search for users","operationId":"searchUsers_1","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of users","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchableUser"}}}}},"400":{"description":"Bad query parameter"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/settings":{"get":{"tags":["Settings"],"summary":"Get the console settings","operationId":"getConsoleSettings","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Console configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsoleSettingsEntity"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Settings"],"summary":"Save the console settings","operationId":"saveConsoleSettings","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsoleSettingsEntity"}}},"required":true},"responses":{"200":{"description":"Updated console settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsoleSettingsEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/social-identities":{"get":{"tags":["Portal","Authentication","Identity Providers"],"summary":"Get the list of social identity providers","operationId":"getSocialIdentityProviders_1","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List social identity providers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialIdentityProviderEntity"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user":{"get":{"tags":["Current User"],"summary":"Get the authenticated user","operationId":"getCurrentUser","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Authenticated user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}},"401":{"description":"Unauthorized user"},"500":{"description":"Internal server error"}}},"put":{"tags":["Current User"],"summary":"Update the authenticated user","operationId":"updateCurrentUser","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/UpdateUserEntity"}}},"required":true},"responses":{"200":{"description":"Updated user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"400":{"description":"Invalid user profile"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Current User"],"summary":"Delete the current logged user","operationId":"deleteCurrentUser","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Current user successfully deleted"},"401":{"description":"Unauthorized"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user/avatar":{"get":{"tags":["Current User"],"summary":"Get user's avatar","operationId":"getCurrentUserPicture","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's avatar","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user/login":{"post":{"tags":["Current User"],"summary":"Login","operationId":"login","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/organizations/{orgId}/user/logout":{"post":{"tags":["Current User"],"summary":"Logout","operationId":"logoutCurrentUser","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/user/newsletter/_subscribe":{"post":{"tags":["Newsletter","Current User"],"summary":"Subscribe to the newsletter the authenticated user","operationId":"subscribeNewsletterToCurrentUser","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Updated user","content":{"/":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"400":{"description":"Invalid user profile"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user/newsletter/taglines":{"get":{"tags":["Newsletter","Current User"],"summary":"Get taglines to display in the newsletter","operationId":"getTaglines","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"Retrieved taglines","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user/notifications":{"get":{"tags":["User Notifications","Current User"],"summary":"List user's notifications","operationId":"getUserNotifications","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's notifications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalNotificationPageResult"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["User Notifications","Current User"],"summary":"Delete all user's notifications","operationId":"deleteAllUserNotifications","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Notifications successfully deleted"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user/notifications/{notification}":{"delete":{"tags":["User Notifications","Current User"],"summary":"Delete a single user's notification","operationId":"deleteUserNotification","parameters":[{"name":"notification","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"Notification successfully deleted"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user/tags":{"get":{"tags":["Current User"],"summary":"Get the user's allowed sharding tags","operationId":"getUserShardingTags","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's sharding tags","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user/tasks":{"get":{"tags":["Current User"],"summary":"Get the user's tasks","operationId":"getUserTasks","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's tasks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEntityPagedResult"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user/tokens":{"get":{"tags":["User Tokens","Current User"],"summary":"List user's personal tokens","operationId":"getTokens","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's personal tokens","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TokenEntity"}}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"post":{"tags":["User Tokens","Current User"],"summary":"Create a personal token","operationId":"createTokens","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTokenEntity"}}},"required":true},"responses":{"201":{"description":"A new personal token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenEntity"}}}},"500":{"description":"Internal server error"}}},"delete":{"tags":["User Tokens","Current User"],"summary":"Revoke all user's personal tokens","operationId":"revokeAllTokens","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User's personal tokens revoked"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/user/tokens/{token}":{"delete":{"tags":["User Tokens","Current User"],"summary":"Revoke a single user's personal tokens","operationId":"revokeToken","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User's personal token revoked"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users":{"get":{"tags":["Users"],"summary":"Search for users using the search engine","description":"User must have the ORGANIZATION_USERS[READ] permission to use this service","operationId":"getAllUsers_1","parameters":[{"name":"q","in":"query","schema":{"type":"string"}},{"name":"size","in":"query","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List users matching the query criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPageResult"}}}},"500":{"description":"Internal server error"}}},"post":{"tags":["Users"],"summary":"Create a user","description":"User must have the ORGANIZATION_USERS[CREATE] permission to use this service","operationId":"createUser_1","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPreRegisterUserEntity"}}}},"responses":{"200":{"description":"List users matching the query criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/registration":{"post":{"tags":["User Registration","Users"],"summary":"Register a user","description":"User registration must be enabled","operationId":"registerUser_1","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewExternalUserEntity"}}}},"responses":{"200":{"description":"User successfully registered","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/registration/finalize":{"post":{"tags":["User Registration","Users"],"summary":"Finalize user registration","description":"User registration must be enabled","operationId":"finalizeUserRegistration_1","parameters":[{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterUserEntity"}}}},"responses":{"200":{"description":"User successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/{userId}":{"get":{"tags":["Users"],"summary":"Retrieve a user","description":"User must have the ORGANIZATION_USERS[READ] permission to use this service","operationId":"getUser_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"A user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Users"],"summary":"Delete a user","description":"User must have the ORGANIZATION_USERS[DELETE] permission to use this service","operationId":"deleteUser_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User successfully deleted"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/{userId}/_process":{"post":{"tags":["Users"],"summary":"Process a user registration by accepting or rejecting it","operationId":"validateRegistration_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"type":"boolean"}}}},"responses":{"200":{"description":"Processed user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/{userId}/avatar":{"get":{"tags":["Users"],"summary":"Get the user's avatar","operationId":"getUserAvatar_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's avatar","content":{"/":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/{userId}/changePassword":{"post":{"tags":["Users"],"summary":"Change user password after a reset","description":"User registration must be enabled","operationId":"finalizeResetPassword_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/ResetPasswordUserEntity"}}}},"responses":{"200":{"description":"User successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/{userId}/groups":{"get":{"tags":["Users"],"summary":"List of groups the user belongs to","description":"User must have the ORGANIZATION_USERS[READ] permission to use this service","operationId":"getUserGroups_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of user groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupEntity"}}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/{userId}/memberships":{"get":{"tags":["Users"],"summary":"List of memberships the user belongs to","description":"User must have the ORGANIZATION_USERS[READ] permission to use this service","operationId":"getUserMemberships_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"List of user memberships","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserMembershipList"}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/{userId}/resetPassword":{"post":{"tags":["Users"],"summary":"Reset the user's password","description":"User must have the ORGANIZATION_USERS[UPDATE] permission to use this service","operationId":"resetUserPassword_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User's password reset"},"400":{"description":"reset page URL must not be null"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/{userId}/roles":{"put":{"tags":["Users"],"operationId":"updateUserRoles_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"/":{"schema":{"$ref":"#/components/schemas/UserReferenceRoleEntity"}}},"required":true},"responses":{"default":{"description":"default response","content":{"/":{}}}}}},"/organizations/{orgId}/users/{userId}/tokens":{"get":{"tags":["User Tokens","Users"],"summary":"List user's personal tokens","operationId":"getUserTokens_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"200":{"description":"User's personal tokens","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TokenEntity"}}}}},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}},"post":{"tags":["User Tokens","Users"],"summary":"Create a personal token","operationId":"createToken_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTokenEntity"}}},"required":true},"responses":{"201":{"description":"A new personal token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenEntity"}}}},"500":{"description":"Internal server error"}}}},"/organizations/{orgId}/users/{userId}/tokens/{token}":{"delete":{"tags":["User Tokens","Users"],"summary":"Revoke a single user's personal tokens","operationId":"revokeToken_3","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"path","description":"The ID of the Organization","required":true,"schema":{"type":"string","default":"DEFAULT"}}],"responses":{"204":{"description":"User's personal token revoked"},"404":{"description":"User not found"},"500":{"description":"Internal server error"}}}}},"components":{"schemas":{"AccessControlEntity":{"type":"object","properties":{"referenceId":{"type":"string"},"referenceType":{"type":"string"}}},"AggregationCondition":{"required":["duration","function","operator","threshold"],"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"function":{"type":"string","enum":["COUNT","AVG","MIN","MAX","P50","P90","P95","P99"]},"property":{"type":"string"},"operator":{"type":"string","enum":["LT","LTE","GTE","GT"]},"threshold":{"type":"number","format":"double"},"timeUnit":{"type":"string","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"]},"duration":{"type":"integer","format":"int64"}}}]},"AggregationsParam":{"type":"array","items":{"type":"string"}},"Alert":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"AlertAnalyticsEntity":{"type":"object","properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AlertTriggerAnalytics"}},"bySeverity":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}},"AlertEventEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"message":{"type":"string"}}},"AlertEventPage":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AlertEventEntity"}},"pageElements":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"AlertEventRuleEntity":{"type":"object","properties":{"event":{"type":"string"}}},"AlertMetric":{"type":"object","properties":{"description":{"type":"string"},"key":{"type":"string"},"thresholds":{"type":"array","items":{"$ref":"#/components/schemas/AlertThreshold"}}}},"AlertReferenceType":{"type":"string","enum":["API","APPLICATION","ENVIRONMENT"]},"AlertStatusEntity":{"type":"object","properties":{"available_plugins":{"type":"integer","format":"int32"},"enabled":{"type":"boolean"}}},"AlertThreshold":{"type":"object","properties":{"description":{"type":"string"},"key":{"type":"string"}}},"AlertTriggerAnalytics":{"type":"object","properties":{"description":{"type":"string"},"events_count":{"type":"integer","format":"int32"},"id":{"type":"string"},"name":{"type":"string"},"severity":{"type":"string"},"type":{"type":"string"}}},"AlertTriggerEntity":{"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}},"counters":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"created_at":{"type":"string","format":"date-time"},"dampening":{"$ref":"#/components/schemas/Dampening"},"description":{"type":"string"},"enabled":{"type":"boolean"},"environment_id":{"type":"string"},"event_rules":{"type":"array","items":{"$ref":"#/components/schemas/AlertEventRuleEntity"}},"filters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"id":{"type":"string"},"last_alert_at":{"type":"string","format":"date-time"},"last_alert_message":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"name":{"type":"string"},"notificationPeriods":{"type":"array","items":{"$ref":"#/components/schemas/Period"}},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"parent_id":{"type":"string"},"reference_id":{"type":"string"},"reference_type":{"$ref":"#/components/schemas/AlertReferenceType"},"severity":{"type":"string","enum":["INFO","WARNING","CRITICAL"]},"source":{"type":"string"},"template":{"type":"boolean"},"type":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"Analytics":{"type":"object","properties":{"clientTimeout":{"type":"integer","format":"int64"}}},"AnalyticsAverageType":{"type":"string","enum":["AVAILABILITY","RESPONSE_TIME"]},"AnalyticsType":{"type":"string","enum":["GROUP_BY","DATE_HISTO","COUNT","STATS"]},"Api":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"owner":{"$ref":"#/components/schemas/User"},"version":{"type":"string"}}},"ApiDeploymentEntity":{"type":"object","properties":{"deploymentLabel":{"maxLength":32,"minLength":0,"type":"string","description":"Label for an Api deployment. Duplicate names can exists.","example":"My deployment"}}},"ApiEntity":{"required":["proxy"],"type":"object","properties":{"background":{"type":"string","description":"the API background encoded in base64"},"background_url":{"type":"string","description":"the API background url.","example":"https://gravitee.mycompany.com/management/apis/6c530064-0b2c-4004-9300-640b2ce0047b/background"},"categories":{"uniqueItems":true,"type":"array","description":"the list of categories associated with this API","example":"Product, Customer, Misc","items":{"type":"string","description":"the list of categories associated with this API","example":"Product, Customer, Misc"}},"context_path":{"type":"string","description":"API's context path.","example":"/my-awesome-api"},"created_at":{"type":"string","description":"The date (as a timestamp) when the API was created.","format":"date-time"},"crossId":{"type":"string","description":"API's crossId. Identifies API across environments.","example":"df83b2a4-cc3e-3f80-9f0d-c138c106c076"},"definition_context":{"$ref":"#/components/schemas/DefinitionContext"},"deployed_at":{"type":"string","description":"The last date (as timestamp) when the API was deployed.","format":"date-time"},"description":{"type":"string","description":"API's description. A short description of your API.","example":"I can use a hundred characters to describe this API."},"disable_membership_notifications":{"type":"boolean"},"entrypoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiEntrypointEntity"}},"execution_mode":{"type":"string","description":"Api's execution mode. Define if the execution mode should use v3 or jupiter mode.","example":"v3","enum":["V3","JUPITER"]},"flow_mode":{"type":"string","description":"API's flow mode.","example":"BEST_MATCH","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","description":"a list of flows (the policies configuration)","items":{"$ref":"#/components/schemas/Flow"}},"gravitee":{"type":"string","description":"API's gravitee definition version"},"groups":{"uniqueItems":true,"type":"array","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"id":{"type":"string","description":"API's uuid.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"labels":{"type":"array","description":"the free list of labels associated with this API","example":"json, read_only, awesome","items":{"type":"string","description":"the free list of labels associated with this API","example":"json, read_only, awesome"}},"lifecycle_state":{"$ref":"#/components/schemas/ApiLifecycleState"},"name":{"type":"string","description":"API's name. Duplicate names can exists.","example":"My Api"},"owner":{"$ref":"#/components/schemas/PrimaryOwnerEntity"},"path_mappings":{"uniqueItems":true,"type":"array","description":"A list of paths used to aggregate data in analytics","example":"/products/:productId, /products/:productId/media","items":{"type":"string","description":"A list of paths used to aggregate data in analytics","example":"/products/:productId, /products/:productId/media"}},"paths":{"type":"object","additionalProperties":{"type":"array","description":"a map where you can associate a path to a configuration (the policies configuration)","items":{"$ref":"#/components/schemas/Rule"}},"description":"a map where you can associate a path to a configuration (the policies configuration)"},"picture":{"type":"string","description":"the API logo encoded in base64"},"picture_url":{"type":"string","description":"the API logo url.","example":"https://gravitee.mycompany.com/management/apis/6c530064-0b2c-4004-9300-640b2ce0047b/picture"},"plans":{"uniqueItems":true,"type":"array","description":"a list of plans with flows (the policies configuration)","items":{"$ref":"#/components/schemas/PlanEntity"}},"properties":{"type":"array","description":"A dictionary (could be dynamic) of properties available in the API context.","items":{"$ref":"#/components/schemas/Property"}},"proxy":{"$ref":"#/components/schemas/Proxy"},"resources":{"type":"array","description":"The list of API resources used by policies like cache resources or oauth2","items":{"$ref":"#/components/schemas/Resource"}},"response_templates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ResponseTemplate"},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-ky is missing, ..."},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-ky is missing, ..."},"services":{"$ref":"#/components/schemas/Services"},"state":{"type":"string","description":"The status of the API regarding the gateway.","example":"STARTED","enum":["INITIALIZED","STOPPED","STOPPING","STARTED","CLOSED"]},"tags":{"uniqueItems":true,"type":"array","description":"the list of sharding tags associated with this API.","example":"public, private","items":{"type":"string","description":"the list of sharding tags associated with this API.","example":"public, private"}},"updated_at":{"type":"string","description":"The last date (as a timestamp) when the API was updated.","format":"date-time"},"version":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"},"visibility":{"$ref":"#/components/schemas/Visibility"},"workflow_state":{"$ref":"#/components/schemas/WorkflowState"}}},"ApiEntityV4":{"type":"object","properties":{"apiVersion":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"},"background":{"type":"string","description":"the API background encoded in base64"},"backgroundUrl":{"type":"string","description":"the API background url.","example":"https://gravitee.mycompany.com/management/apis/6c530064-0b2c-4004-9300-640b2ce0047b/background"},"categories":{"uniqueItems":true,"type":"array","description":"the list of categories associated with this API","example":"Product, Customer, Misc","items":{"type":"string","description":"the list of categories associated with this API","example":"Product, Customer, Misc"}},"createdAt":{"type":"string","description":"The date (as a timestamp) when the API was created.","format":"date-time"},"crossId":{"type":"string","description":"API's crossId. Identifies API across environments.","example":"df83b2a4-cc3e-3f80-9f0d-c138c106c076"},"definitionContext":{"$ref":"#/components/schemas/DefinitionContext"},"definitionVersion":{"type":"string","description":"API's gravitee definition version","enum":["1.0.0","2.0.0","4.0.0"]},"deployedAt":{"type":"string","description":"The last date (as timestamp) when the API was deployed.","format":"date-time"},"description":{"type":"string","description":"API's description. A short description of your API.","example":"I can use a hundred characters to describe this API."},"disableMembershipNotifications":{"type":"boolean"},"endpointGroups":{"type":"array","description":"A list of endpoint describing the endpoints to contact.","items":{"$ref":"#/components/schemas/EndpointGroupV4"}},"flowMode":{"type":"string","description":"API's flow mode.","example":"BEST_MATCH","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","description":"A list of flows containing the policies configuration.","items":{"$ref":"#/components/schemas/FlowV4"}},"groups":{"uniqueItems":true,"type":"array","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"id":{"type":"string","description":"API's uuid.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"labels":{"type":"array","description":"the free list of labels associated with this API","example":"json, read_only, awesome","items":{"type":"string","description":"the free list of labels associated with this API","example":"json, read_only, awesome"}},"lifecycleState":{"$ref":"#/components/schemas/ApiLifecycleState"},"listeners":{"type":"array","description":"A list of listeners used to describe our you api could be reached.","items":{"$ref":"#/components/schemas/ListenerV4"}},"name":{"type":"string","description":"API's name. Duplicate names can exists.","example":"My Api"},"picture":{"type":"string","description":"the API logo encoded in base64"},"pictureUrl":{"type":"string","description":"the API logo URL.","example":"https://gravitee.mycompany.com/management/apis/6c530064-0b2c-4004-9300-640b2ce0047b/picture"},"plans":{"uniqueItems":true,"type":"array","description":"A list of plans to apply on the API","items":{"$ref":"#/components/schemas/PlanEntityV4"}},"primaryOwner":{"$ref":"#/components/schemas/PrimaryOwnerEntity"},"properties":{"type":"array","description":"A dictionary (could be dynamic) of properties available in the API context.","items":{"$ref":"#/components/schemas/PropertyV4"}},"resources":{"type":"array","description":"The list of API resources used by policies like cache resources or oauth2","items":{"$ref":"#/components/schemas/ResourceV4"}},"responseTemplates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ResponseTemplateV4"},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-key is missing, ..."},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-key is missing, ..."},"services":{"$ref":"#/components/schemas/ApiServicesV4"},"state":{"type":"string","description":"The status of the API regarding the gateway.","example":"STARTED","enum":["INITIALIZED","STOPPED","STOPPING","STARTED","CLOSED"]},"tags":{"uniqueItems":true,"type":"array","description":"The list of sharding tags associated with this API.","example":"public, private","items":{"type":"string","description":"The list of sharding tags associated with this API.","example":"public, private"}},"type":{"type":"string","description":"API's type","example":"async","enum":["SYNC","ASYNC"]},"updatedAt":{"type":"string","description":"The last date (as a timestamp) when the API was updated.","format":"date-time"},"visibility":{"$ref":"#/components/schemas/Visibility"},"workflowState":{"$ref":"#/components/schemas/WorkflowState"}}},"ApiEntrypointEntity":{"type":"object","properties":{"host":{"type":"string"},"tags":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"target":{"type":"string"}}},"ApiGroupsWithMembersMap":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/GroupMemberEntity"}}},"ApiHeaderEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"updated_at":{"type":"string","format":"date-time"},"value":{"type":"string"}}},"ApiKeyEntity":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/ApplicationEntity"},"created_at":{"type":"string","format":"date-time"},"daysToExpirationOnLastNotification":{"type":"integer","format":"int32"},"expire_at":{"type":"string","format":"date-time"},"expired":{"type":"boolean"},"id":{"type":"string"},"key":{"type":"string"},"paused":{"type":"boolean"},"revoked":{"type":"boolean"},"revoked_at":{"type":"string","format":"date-time"},"subscriptions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/SubscriptionEntity"}},"updated_at":{"type":"string","format":"date-time"}}},"ApiKeyMode":{"type":"string","enum":["SHARED","EXCLUSIVE","UNSPECIFIED"]},"ApiLifecycleState":{"type":"string","enum":["CREATED","PUBLISHED","UNPUBLISHED","DEPRECATED","ARCHIVED"]},"ApiListItem":{"type":"object","properties":{"categories":{"uniqueItems":true,"type":"array","description":"the list of categories associated with this API","example":"Product, Customer, Misc","items":{"type":"string","description":"the list of categories associated with this API","example":"Product, Customer, Misc"}},"context_path":{"type":"string","description":"API's context path.","example":"/my-awesome-api"},"created_at":{"type":"string","description":"The date (as a timestamp) when the API was created.","format":"date-time"},"description":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"},"healthcheck_enabled":{"type":"boolean","description":"true if HealthCheck is enabled globally or on one endpoint"},"id":{"type":"string","description":"Api's uuid.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"labels":{"type":"array","description":"the free list of labels associated with this API","example":"json, read_only, awesome","items":{"type":"string","description":"the free list of labels associated with this API","example":"json, read_only, awesome"}},"lifecycle_state":{"$ref":"#/components/schemas/ApiLifecycleState"},"name":{"type":"string","description":"Api's name. Duplicate names can exists.","example":"My Api"},"numberOfRatings":{"type":"integer","description":"How many consumers have evaluated the API","format":"int32","example":4},"origin":{"type":"string","description":"The origin of the api (management, kubernetes, ...)."},"owner":{"$ref":"#/components/schemas/PrimaryOwnerEntity"},"picture_url":{"type":"string","description":"the API logo url.","example":"https://gravitee.mycompany.com/management/apis/6c530064-0b2c-4004-9300-640b2ce0047b/picture"},"rate":{"type":"number","description":"How consumers have evaluated the API (between 0 to 5)","format":"double","example":4},"role":{"type":"string"},"state":{"type":"string","description":"The status of the API regarding the gateway.","example":"STARTED","enum":["INITIALIZED","STOPPED","STOPPING","STARTED","CLOSED"]},"tags":{"uniqueItems":true,"type":"array","description":"the list of sharding tags associated with this API.","example":"public, private","items":{"type":"string","description":"the list of sharding tags associated with this API.","example":"public, private"}},"updated_at":{"type":"string","description":"The last date (as a timestamp) when the API was updated.","format":"date-time"},"version":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"},"virtual_hosts":{"type":"array","items":{"$ref":"#/components/schemas/VirtualHost"}},"visibility":{"$ref":"#/components/schemas/Visibility"},"workflow_state":{"$ref":"#/components/schemas/WorkflowState"}}},"ApiListItemPagedResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiListItem"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object"}}},"page":{"$ref":"#/components/schemas/Page"}}},"ApiMembership":{"required":["role"],"type":"object","properties":{"id":{"type":"string","description":"User's technical identifier."},"reference":{"type":"string","description":"User's reference for user providing from an identity provider."},"role":{"type":"string","description":"Role's name"}}},"ApiMetadataEntity":{"required":["key","value"],"type":"object","properties":{"apiId":{"type":"string"},"defaultValue":{"type":"string"},"format":{"$ref":"#/components/schemas/MetadataFormat"},"key":{"maxLength":2147483647,"minLength":1,"type":"string"},"name":{"type":"string"},"value":{"maxLength":2147483647,"minLength":1,"type":"string"}}},"ApiMetrics":{"type":"object","properties":{"buckets":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"number"}}},"global":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}}}},"ApiQualityMetrics":{"type":"object","properties":{"categoriesWeight":{"type":"integer","format":"int32"},"descriptionMinLength":{"type":"integer","format":"int32"},"descriptionWeight":{"type":"integer","format":"int32"},"enabled":{"type":"boolean"},"functionalDocumentationWeight":{"type":"integer","format":"int32"},"healthcheckWeight":{"type":"integer","format":"int32"},"labelsWeight":{"type":"integer","format":"int32"},"logoWeight":{"type":"integer","format":"int32"},"technicalDocumentationWeight":{"type":"integer","format":"int32"}}},"ApiQualityMetricsEntity":{"type":"object","properties":{"metrics_passed":{"type":"object","additionalProperties":{"type":"boolean"}},"score":{"type":"number","format":"double"}}},"ApiQualityRuleEntity":{"type":"object","properties":{"api":{"type":"string"},"checked":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"quality_rule":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"ApiRequest":{"type":"object","properties":{"api":{"type":"string"},"apiResponseTime":{"type":"integer","format":"int64"},"application":{"type":"string"},"clientRequest":{"$ref":"#/components/schemas/Request"},"clientResponse":{"$ref":"#/components/schemas/Response"},"endpoint":{"type":"string"},"gateway":{"type":"string"},"host":{"type":"string"},"id":{"type":"string"},"localAddress":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]},"path":{"type":"string"},"plan":{"type":"string"},"proxyRequest":{"$ref":"#/components/schemas/Request"},"proxyResponse":{"$ref":"#/components/schemas/Response"},"remoteAddress":{"type":"string"},"requestContentLength":{"type":"integer","format":"int64"},"responseContentLength":{"type":"integer","format":"int64"},"responseTime":{"type":"integer","format":"int64"},"securityToken":{"type":"string"},"securityType":{"type":"string"},"status":{"type":"integer","format":"int32"},"subscription":{"type":"string"},"tenant":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"transactionId":{"type":"string"},"uri":{"type":"string"},"user":{"type":"string"}}},"ApiRequestItem":{"type":"object","properties":{"application":{"type":"string"},"endpoint":{"type":"boolean"},"id":{"type":"string"},"method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]},"path":{"type":"string"},"plan":{"type":"string"},"responseTime":{"type":"integer","format":"int64"},"status":{"type":"integer","format":"int32"},"timestamp":{"type":"integer","format":"int64"},"transactionId":{"type":"string"},"user":{"type":"string"}}},"ApiRequestItemSearchLogResponse":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/ApiRequestItem"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"total":{"type":"integer","format":"int64"}}},"ApiReview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ApiServicesV4":{"type":"object","properties":{"dynamicProperty":{"$ref":"#/components/schemas/ServiceV4"}},"description":"The configuration of API services like the dynamic properties."},"ApiStateEntity":{"type":"object","properties":{"api_id":{"type":"string"},"is_synchronized":{"type":"boolean"}}},"ApiStatus":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"Application":{"type":"object","properties":{"apiKeyMode":{"$ref":"#/components/schemas/ApiKeyMode"},"description":{"type":"string"},"domain":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"owner":{"$ref":"#/components/schemas/User"},"type":{"type":"string"}}},"ApplicationEntity":{"type":"object","properties":{"api_key_mode":{"$ref":"#/components/schemas/ApiKeyMode"},"background":{"type":"string"},"created_at":{"type":"string","description":"The date (as a timestamp) when the application was created.","format":"date-time"},"description":{"type":"string","description":"Application's description. A short description of your App.","example":"I can use a hundred characters to describe this App."},"disable_membership_notifications":{"type":"boolean"},"domain":{"type":"string","description":"Domain used by the application, if relevant","example":"https://my-app.com"},"groups":{"uniqueItems":true,"type":"array","description":"Application groups. Used to add teams to your application.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"Application groups. Used to add teams to your application.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"id":{"type":"string","description":"Application's uuid.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"name":{"type":"string","description":"Application's name. Duplicate names can exists.","example":"My App"},"owner":{"$ref":"#/components/schemas/PrimaryOwnerEntity"},"picture":{"type":"string"},"settings":{"$ref":"#/components/schemas/ApplicationSettings"},"status":{"type":"string","description":"if the app is ACTIVE or ARCHIVED.","example":"ACTIVE"},"type":{"type":"string","description":"a string to describe the type of your app.","example":"iOS"},"updated_at":{"type":"string","description":"The last date (as a timestamp) when the application was updated.","format":"date-time"}}},"ApplicationGrantTypeEntity":{"type":"object","properties":{"name":{"type":"string"},"response_types":{"type":"array","items":{"type":"string"}},"type":{"type":"string"}}},"ApplicationListItem":{"type":"object","properties":{"api_key_mode":{"$ref":"#/components/schemas/ApiKeyMode"},"background":{"type":"string"},"background_url":{"type":"string"},"created_at":{"type":"string","description":"The date (as a timestamp) when the application was created.","format":"date-time"},"description":{"type":"string","description":"Application's description. A short description of your App.","example":"I can use a hundred characters to describe this App."},"disable_membership_notifications":{"type":"boolean"},"domain":{"type":"string","description":"Domain used by the application, if relevant","example":"https://my-app.com"},"groups":{"uniqueItems":true,"type":"array","description":"Application groups. Used to add teams to your application.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"Application groups. Used to add teams to your application.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"id":{"type":"string","description":"Application's uuid.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"name":{"type":"string","description":"Application's name. Duplicate names can exists.","example":"My App"},"owner":{"$ref":"#/components/schemas/PrimaryOwnerEntity"},"picture":{"type":"string"},"picture_url":{"type":"string"},"settings":{"$ref":"#/components/schemas/ApplicationSettings"},"status":{"type":"string","description":"if the app is ACTIVE or ARCHIVED.","example":"ACTIVE"},"type":{"type":"string","description":"a string to describe the type of your app.","example":"iOS"},"updated_at":{"type":"string","description":"The last date (as a timestamp) when the application was updated.","format":"date-time"}}},"ApplicationListItemPagedResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationListItem"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object"}}},"page":{"$ref":"#/components/schemas/Page"}}},"ApplicationMembership":{"required":["role"],"type":"object","properties":{"id":{"type":"string","description":"User's technical identifier."},"reference":{"type":"string","description":"User's reference for user providing from an identity provider."},"role":{"type":"string","description":"Role's name"}}},"ApplicationMetadataEntity":{"required":["key","value"],"type":"object","properties":{"applicationId":{"type":"string"},"defaultValue":{"type":"string"},"format":{"$ref":"#/components/schemas/MetadataFormat"},"key":{"maxLength":2147483647,"minLength":1,"type":"string"},"name":{"type":"string"},"value":{"maxLength":2147483647,"minLength":1,"type":"string"}}},"ApplicationRequest":{"type":"object","properties":{"api":{"type":"string"},"host":{"type":"string"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]},"path":{"type":"string"},"plan":{"type":"string"},"request":{"$ref":"#/components/schemas/Request"},"requestContentLength":{"type":"integer","format":"int64"},"response":{"$ref":"#/components/schemas/Response"},"responseContentLength":{"type":"integer","format":"int64"},"responseTime":{"type":"integer","format":"int64"},"securityToken":{"type":"string"},"securityType":{"type":"string"},"status":{"type":"integer","format":"int32"},"timestamp":{"type":"integer","format":"int64"},"transactionId":{"type":"string"},"uri":{"type":"string"},"user":{"type":"string"}}},"ApplicationRequestItem":{"type":"object","properties":{"api":{"type":"string"},"id":{"type":"string"},"method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]},"path":{"type":"string"},"plan":{"type":"string"},"responseTime":{"type":"integer","format":"int64"},"status":{"type":"integer","format":"int32"},"timestamp":{"type":"integer","format":"int64"},"transactionId":{"type":"string"},"user":{"type":"string"}}},"ApplicationRequestItemSearchLogResponse":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRequestItem"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"total":{"type":"integer","format":"int64"}}},"ApplicationSettings":{"type":"object","properties":{"app":{"$ref":"#/components/schemas/SimpleApplicationSettings"},"oauth":{"$ref":"#/components/schemas/OAuthClientSettings"}}},"ApplicationTypeEntity":{"type":"object","properties":{"allowed_grant_types":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationGrantTypeEntity"}},"default_grant_types":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationGrantTypeEntity"}},"description":{"type":"string"},"id":{"type":"string"},"mandatory_grant_types":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationGrantTypeEntity"}},"name":{"type":"string"},"requires_redirect_uris":{"type":"boolean"}}},"ApplicationTypes":{"type":"object","properties":{"backend_to_backend":{"$ref":"#/components/schemas/Enabled"},"browser":{"$ref":"#/components/schemas/Enabled"},"native":{"$ref":"#/components/schemas/Enabled"},"simple":{"$ref":"#/components/schemas/Enabled"},"web":{"$ref":"#/components/schemas/Enabled"}}},"Audit":{"type":"object","properties":{"enabled":{"type":"boolean"},"trail":{"$ref":"#/components/schemas/AuditTrail"}}},"AuditEntity":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"event":{"type":"string"},"id":{"type":"string"},"patch":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}},"referenceId":{"type":"string"},"referenceType":{"$ref":"#/components/schemas/AuditReferenceType"},"user":{"type":"string"}}},"AuditEntityMetadataPage":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AuditEntity"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"pageElements":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"AuditEvent":{"type":"object"},"AuditReferenceType":{"type":"string","enum":["ORGANIZATION","ENVIRONMENT","APPLICATION","API"]},"AuditTrail":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"AuditType":{"type":"string","enum":["ORGANIZATION","ENVIRONMENT","APPLICATION","API"]},"BodyPart":{"type":"object","properties":{"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"}},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"}}},"CategoryEntity":{"required":["name"],"type":"object","properties":{"background":{"type":"string"},"background_url":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"description":{"type":"string"},"hidden":{"type":"boolean"},"highlightApi":{"type":"string"},"id":{"type":"string"},"key":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"order":{"type":"integer","format":"int32"},"page":{"type":"string"},"picture":{"type":"string"},"picture_url":{"type":"string"},"totalApis":{"type":"integer","format":"int64"},"updatedAt":{"type":"string","format":"date-time"}}},"ChannelSelectorV4":{"required":["channel","channelOperator","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Selector"},{"type":"object","properties":{"operations":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["SUB","PUB"]}},"channel":{"type":"string"},"channelOperator":{"type":"string","enum":["STARTS_WITH","EQUALS"]}}}]},"ClientRegistration":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ClientRegistrationProviderEntity":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"discovery_endpoint":{"type":"string"},"id":{"type":"string"},"initial_access_token":{"type":"string"},"initial_access_token_type":{"$ref":"#/components/schemas/InitialAccessTokenType"},"name":{"type":"string"},"renew_client_secret_endpoint":{"type":"string"},"renew_client_secret_method":{"type":"string"},"renew_client_secret_support":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}},"software_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"ClientRegistrationProviderListItem":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"Company":{"type":"object","properties":{"name":{"type":"string"}}},"CompareCondition":{"required":["multiplier","operator","property","property2"],"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"property":{"type":"string"},"operator":{"type":"string","enum":["LT","LTE","GTE","GT"]},"multiplier":{"type":"number","format":"double"},"property2":{"type":"string"}}}]},"Condition":{"type":"object","properties":{"projections":{"type":"array","items":{"$ref":"#/components/schemas/Projection"}},"type":{"type":"string","enum":["STRING","THRESHOLD","THRESHOLD_RANGE","RATE","FREQUENCY","AGGREGATION","COMPARE","STRING_COMPARE","MISSING_DATA"]}},"discriminator":{"propertyName":"type"}},"ConditionSelectorV4":{"required":["condition","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Selector"},{"type":"object","properties":{"condition":{"type":"string"}}}]},"ConnectorListItem":{"type":"object","properties":{"description":{"type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"schema":{"type":"string"},"supportedTypes":{"type":"array","items":{"type":"string"}},"version":{"type":"string"}}},"ConsoleAnalyticsPendo":{"type":"object","properties":{"apiKey":{"type":"string"},"enabled":{"type":"boolean"}}},"ConsoleAuthentication":{"type":"object","properties":{"github":{"$ref":"#/components/schemas/GithubAuthentication"},"google":{"$ref":"#/components/schemas/GoogleAuthentication"},"localLogin":{"$ref":"#/components/schemas/Enabled"},"oauth2":{"$ref":"#/components/schemas/OAuth2Authentication"}}},"ConsoleConfigEntity":{"type":"object","properties":{"alert":{"$ref":"#/components/schemas/Alert"},"analyticsPendo":{"$ref":"#/components/schemas/ConsoleAnalyticsPendo"},"authentication":{"$ref":"#/components/schemas/ConsoleAuthentication"},"jupiterMode":{"$ref":"#/components/schemas/JupiterMode"},"logging":{"$ref":"#/components/schemas/Logging"},"maintenance":{"$ref":"#/components/schemas/Maintenance"},"management":{"$ref":"#/components/schemas/Management"},"newsletter":{"$ref":"#/components/schemas/Newsletter"},"reCaptcha":{"$ref":"#/components/schemas/ConsoleReCaptcha"},"scheduler":{"$ref":"#/components/schemas/ConsoleScheduler"},"theme":{"$ref":"#/components/schemas/Theme"}}},"ConsoleCors":{"type":"object","properties":{"allowHeaders":{"type":"array","items":{"type":"string"}},"allowMethods":{"type":"array","items":{"type":"string"}},"allowOrigin":{"type":"array","items":{"type":"string"}},"exposedHeaders":{"type":"array","items":{"type":"string"}},"maxAge":{"type":"integer","format":"int32"}}},"ConsoleReCaptcha":{"type":"object","properties":{"enabled":{"type":"boolean"},"siteKey":{"type":"string"}}},"ConsoleScheduler":{"type":"object","properties":{"notifications":{"type":"integer","format":"int32"},"tasks":{"type":"integer","format":"int32"}}},"ConsoleSettingsEntity":{"type":"object","properties":{"alert":{"$ref":"#/components/schemas/Alert"},"analyticsPendo":{"$ref":"#/components/schemas/ConsoleAnalyticsPendo"},"authentication":{"$ref":"#/components/schemas/ConsoleAuthentication"},"cors":{"$ref":"#/components/schemas/ConsoleCors"},"email":{"$ref":"#/components/schemas/Email"},"jupiterMode":{"$ref":"#/components/schemas/JupiterMode"},"logging":{"$ref":"#/components/schemas/Logging"},"maintenance":{"$ref":"#/components/schemas/Maintenance"},"management":{"$ref":"#/components/schemas/Management"},"metadata":{"type":"object","properties":{"all":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"type":"string"}},"readOnly":true},"newsletter":{"$ref":"#/components/schemas/Newsletter"},"reCaptcha":{"$ref":"#/components/schemas/ConsoleReCaptcha"},"scheduler":{"$ref":"#/components/schemas/ConsoleScheduler"},"theme":{"$ref":"#/components/schemas/Theme"}}},"Consumer":{"type":"object","properties":{"consumerId":{"type":"string"},"consumerType":{"type":"string","enum":["TAG"]}}},"ContentDisposition":{"type":"object","properties":{"creationDate":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"modificationDate":{"type":"string","format":"date-time"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"type":{"type":"string"}}},"Cors":{"type":"object","properties":{"allowCredentials":{"type":"boolean"},"allowHeaders":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"allowMethods":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"allowOrigin":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean"},"exposeHeaders":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"maxAge":{"type":"integer","format":"int32"},"runPolicies":{"type":"boolean"}}},"CustomUserFieldEntity":{"required":["key","label"],"type":"object","properties":{"key":{"maxLength":2147483647,"minLength":1,"type":"string"},"label":{"maxLength":2147483647,"minLength":1,"type":"string"},"required":{"type":"boolean"},"values":{"type":"array","items":{"type":"string"}}}},"Dampening":{"required":["mode"],"type":"object","properties":{"duration":{"type":"integer","format":"int64"},"mode":{"type":"string","enum":["STRICT_COUNT","RELAXED_COUNT","RELAXED_TIME","STRICT_TIME"]},"timeUnit":{"type":"string","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"]},"totalEvaluations":{"type":"integer","format":"int32"},"trueEvaluations":{"type":"integer","format":"int32"}}},"DashboardEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"definition":{"type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"query_filter":{"type":"string"},"reference_id":{"type":"string"},"reference_type":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"DashboardReferenceType":{"type":"string","enum":["API","APPLICATION","PLATFORM","HOME"]},"Dashboards":{"type":"object","properties":{"apiStatus":{"$ref":"#/components/schemas/ApiStatus"}}},"DebugApiEntity":{"required":["proxy"],"type":"object","properties":{"background":{"type":"string","description":"the API background encoded in base64"},"background_url":{"type":"string","description":"the API background url.","example":"https://gravitee.mycompany.com/management/apis/6c530064-0b2c-4004-9300-640b2ce0047b/background"},"categories":{"uniqueItems":true,"type":"array","description":"the list of categories associated with this API","example":"Product, Customer, Misc","items":{"type":"string","description":"the list of categories associated with this API","example":"Product, Customer, Misc"}},"context_path":{"type":"string","description":"API's context path.","example":"/my-awesome-api"},"created_at":{"type":"string","description":"The date (as a timestamp) when the API was created.","format":"date-time"},"crossId":{"type":"string","description":"API's crossId. Identifies API across environments.","example":"df83b2a4-cc3e-3f80-9f0d-c138c106c076"},"definition_context":{"$ref":"#/components/schemas/DefinitionContext"},"deployed_at":{"type":"string","description":"The last date (as timestamp) when the API was deployed.","format":"date-time"},"description":{"type":"string","description":"API's description. A short description of your API.","example":"I can use a hundred characters to describe this API."},"disable_membership_notifications":{"type":"boolean"},"entrypoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiEntrypointEntity"}},"execution_mode":{"type":"string","description":"Api's execution mode. Define if the execution mode should use v3 or jupiter mode.","example":"v3","enum":["V3","JUPITER"]},"flow_mode":{"type":"string","description":"API's flow mode.","example":"BEST_MATCH","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","description":"a list of flows (the policies configuration)","items":{"$ref":"#/components/schemas/Flow"}},"gravitee":{"type":"string","description":"API's gravitee definition version"},"groups":{"uniqueItems":true,"type":"array","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"id":{"type":"string","description":"API's uuid.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"labels":{"type":"array","description":"the free list of labels associated with this API","example":"json, read_only, awesome","items":{"type":"string","description":"the free list of labels associated with this API","example":"json, read_only, awesome"}},"lifecycle_state":{"$ref":"#/components/schemas/ApiLifecycleState"},"name":{"type":"string","description":"API's name. Duplicate names can exists.","example":"My Api"},"owner":{"$ref":"#/components/schemas/PrimaryOwnerEntity"},"path_mappings":{"uniqueItems":true,"type":"array","description":"A list of paths used to aggregate data in analytics","example":"/products/:productId, /products/:productId/media","items":{"type":"string","description":"A list of paths used to aggregate data in analytics","example":"/products/:productId, /products/:productId/media"}},"paths":{"type":"object","additionalProperties":{"type":"array","description":"a map where you can associate a path to a configuration (the policies configuration)","items":{"$ref":"#/components/schemas/Rule"}},"description":"a map where you can associate a path to a configuration (the policies configuration)"},"picture":{"type":"string","description":"the API logo encoded in base64"},"picture_url":{"type":"string","description":"the API logo url.","example":"https://gravitee.mycompany.com/management/apis/6c530064-0b2c-4004-9300-640b2ce0047b/picture"},"plans":{"uniqueItems":true,"type":"array","description":"a list of plans with flows (the policies configuration)","items":{"$ref":"#/components/schemas/PlanEntity"}},"properties":{"type":"array","description":"A dictionary (could be dynamic) of properties available in the API context.","items":{"$ref":"#/components/schemas/Property"}},"proxy":{"$ref":"#/components/schemas/Proxy"},"request":{"$ref":"#/components/schemas/HttpRequest"},"resources":{"type":"array","description":"The list of API resources used by policies like cache resources or oauth2","items":{"$ref":"#/components/schemas/Resource"}},"response":{"$ref":"#/components/schemas/HttpResponse"},"response_templates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ResponseTemplate"},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-ky is missing, ..."},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-ky is missing, ..."},"services":{"$ref":"#/components/schemas/Services"},"state":{"type":"string","description":"The status of the API regarding the gateway.","example":"STARTED","enum":["INITIALIZED","STOPPED","STOPPING","STARTED","CLOSED"]},"tags":{"uniqueItems":true,"type":"array","description":"the list of sharding tags associated with this API.","example":"public, private","items":{"type":"string","description":"the list of sharding tags associated with this API.","example":"public, private"}},"updated_at":{"type":"string","description":"The last date (as a timestamp) when the API was updated.","format":"date-time"},"version":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"},"visibility":{"$ref":"#/components/schemas/Visibility"},"workflow_state":{"$ref":"#/components/schemas/WorkflowState"}}},"DefinitionContext":{"type":"object","properties":{"mode":{"type":"string"},"origin":{"type":"string"}},"description":"the context where the api definition was created from"},"DictionaryEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"deployed_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}},"provider":{"$ref":"#/components/schemas/DictionaryProviderEntity"},"state":{"type":"string","enum":["INITIALIZED","STOPPED","STOPPING","STARTED","CLOSED"]},"trigger":{"$ref":"#/components/schemas/DictionaryTriggerEntity"},"type":{"$ref":"#/components/schemas/DictionaryType"},"updated_at":{"type":"string","format":"date-time"}}},"DictionaryListItem":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"deployed_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"properties":{"type":"integer","format":"int32"},"provider":{"type":"string"},"state":{"type":"string","enum":["INITIALIZED","STOPPED","STOPPING","STARTED","CLOSED"]},"type":{"$ref":"#/components/schemas/DictionaryType"},"updated_at":{"type":"string","format":"date-time"}}},"DictionaryProviderEntity":{"required":["configuration","type"],"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/JsonNode"},"type":{"type":"string"}}},"DictionaryTriggerEntity":{"required":["rate","unit"],"type":"object","properties":{"rate":{"type":"integer","format":"int64"},"unit":{"type":"string","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"]}}},"DictionaryType":{"type":"string","enum":["MANUAL","DYNAMIC"]},"Documentation":{"type":"object","properties":{"url":{"type":"string"}}},"DuplicateApiEntity":{"required":["context_path"],"type":"object","properties":{"context_path":{"type":"string"},"filtered_fields":{"type":"array","items":{"type":"string"}},"version":{"type":"string"}}},"DynamicPropertyProviderConfiguration":{"type":"object"},"DynamicPropertyService":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/DynamicPropertyProviderConfiguration"},"enabled":{"type":"boolean"},"provider":{"type":"string","enum":["HTTP"]},"schedule":{"type":"string"}}},"Email":{"type":"object","properties":{"enabled":{"type":"boolean"},"from":{"type":"string"},"host":{"type":"string"},"password":{"type":"string"},"port":{"type":"integer","format":"int32"},"properties":{"$ref":"#/components/schemas/EmailProperties"},"protocol":{"type":"string"},"subject":{"type":"string"},"username":{"type":"string"}}},"EmailProperties":{"type":"object","properties":{"auth":{"type":"boolean"},"sslTrust":{"type":"string"},"startTlsEnable":{"type":"boolean"}}},"Enabled":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"Endpoint":{"type":"object","properties":{"backup":{"type":"boolean"},"healthcheck":{"$ref":"#/components/schemas/EndpointHealthCheckService"},"inherit":{"type":"boolean"},"name":{"type":"string"},"target":{"type":"string"},"tenants":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"weight":{"type":"integer","format":"int32"}}},"EndpointDiscoveryService":{"type":"object","properties":{"configuration":{"type":"object"},"enabled":{"type":"boolean"},"provider":{"type":"string"}}},"EndpointGroup":{"type":"object","properties":{"endpoints":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Endpoint"}},"headers":{"type":"array","items":{"$ref":"#/components/schemas/HttpHeader"}},"http":{"$ref":"#/components/schemas/HttpClientOptions"},"load_balancing":{"$ref":"#/components/schemas/LoadBalancer"},"name":{"type":"string"},"proxy":{"$ref":"#/components/schemas/HttpProxy"},"services":{"$ref":"#/components/schemas/Services"},"ssl":{"$ref":"#/components/schemas/HttpClientSslOptions"}}},"EndpointGroupServicesV4":{"type":"object","properties":{"discovery":{"$ref":"#/components/schemas/ServiceV4"},"healthCheck":{"$ref":"#/components/schemas/ServiceV4"}}},"EndpointGroupV4":{"required":["name","type"],"type":"object","properties":{"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/EndpointV4"}},"loadBalancer":{"$ref":"#/components/schemas/LoadBalancerV4"},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/EndpointGroupServicesV4"},"sharedConfiguration":{"type":"object"},"type":{"type":"string"}},"description":"A list of endpoint describing the endpoints to contact."},"EndpointHealthCheckService":{"type":"object","properties":{"enabled":{"type":"boolean"},"inherit":{"type":"boolean"},"schedule":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/HealthCheckStep"}}}},"EndpointServicesV4":{"type":"object","properties":{"healthCheck":{"$ref":"#/components/schemas/ServiceV4"}}},"EndpointV4":{"required":["name","type"],"type":"object","properties":{"configuration":{"type":"object"},"inheritConfiguration":{"type":"boolean"},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/EndpointServicesV4"},"type":{"type":"string"},"weight":{"type":"integer","format":"int32"}}},"EntrypointEntity":{"type":"object","properties":{"id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"value":{"type":"string"}}},"EntrypointExpandEntityV4":{"type":"object","properties":{"category":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"schema":{"type":"string"},"supportedApiType":{"type":"string","enum":["SYNC","ASYNC"]},"supportedModes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["SUBSCRIBE","PUBLISH","REQUEST_RESPONSE"]}},"version":{"type":"string"}}},"EntrypointPluginEntityV4":{"type":"object","properties":{"category":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"supportedApiType":{"type":"string","enum":["SYNC","ASYNC"]},"supportedModes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["SUBSCRIBE","PUBLISH","REQUEST_RESPONSE"]}},"version":{"type":"string"}}},"EntrypointV4":{"required":["type"],"type":"object","properties":{"configuration":{"type":"object"},"type":{"type":"string"}}},"EnvironmentEntity":{"required":["name","organizationId"],"type":"object","properties":{"cockpitId":{"type":"string"},"description":{"type":"string"},"domainRestrictions":{"type":"array","items":{"type":"string"}},"hrids":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"organizationId":{"type":"string"}}},"EnvironmentPermissionsEntity":{"required":["name"],"type":"object","properties":{"hrids":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"permissions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"EventEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"environments":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"id":{"type":"string"},"parentId":{"type":"string"},"payload":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}},"type":{"$ref":"#/components/schemas/EventType"},"updated_at":{"type":"string","format":"date-time"},"user":{"$ref":"#/components/schemas/UserEntity"}}},"EventEntityPage":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/EventEntity"}},"pageElements":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"EventType":{"type":"string","enum":["PUBLISH_API","PUBLISH_API_RESULT","UNPUBLISH_API","UNPUBLISH_API_RESULT","START_API","STOP_API","GATEWAY_STARTED","GATEWAY_STOPPED","PUBLISH_DICTIONARY","UNPUBLISH_DICTIONARY","START_DICTIONARY","STOP_DICTIONARY","ALERT_NOTIFICATION","PUBLISH_ORGANIZATION","DEBUG_API"]},"EventTypeListParam":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/EventType"}},"Failover":{"type":"object","properties":{"cases":{"type":"array","items":{"type":"string","enum":["TIMEOUT"]}},"maxAttempts":{"type":"integer","format":"int32"},"retryTimeout":{"type":"integer","format":"int64"}}},"FetcherEntity":{"type":"object","properties":{"category":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}}},"FetcherListItem":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"schema":{"type":"string"},"version":{"type":"string"}}},"Filter":{"type":"object","properties":{"projections":{"type":"array","items":{"$ref":"#/components/schemas/Projection"}},"type":{"type":"string","enum":["STRING","THRESHOLD","THRESHOLD_RANGE","RATE","FREQUENCY","AGGREGATION","COMPARE","STRING_COMPARE","MISSING_DATA"]}}},"Flow":{"type":"object","properties":{"condition":{"type":"string"},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/Consumer"}},"enabled":{"type":"boolean"},"methods":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]}},"name":{"type":"string"},"path-operator":{"$ref":"#/components/schemas/PathOperator"},"post":{"type":"array","items":{"$ref":"#/components/schemas/Step"}},"pre":{"type":"array","items":{"$ref":"#/components/schemas/Step"}}}},"FlowV4":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"publish":{"type":"array","items":{"$ref":"#/components/schemas/StepV4"}},"request":{"type":"array","items":{"$ref":"#/components/schemas/StepV4"}},"response":{"type":"array","items":{"$ref":"#/components/schemas/StepV4"}},"selectors":{"type":"array","items":{"$ref":"#/components/schemas/Selector"}},"subscribe":{"type":"array","items":{"$ref":"#/components/schemas/StepV4"}},"tags":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"A list of flows containing the policies configuration."},"FormDataBodyPart":{"type":"object","properties":{"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"formDataContentDisposition":{"$ref":"#/components/schemas/FormDataContentDisposition"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"}},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"name":{"type":"string"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"simple":{"type":"boolean"},"value":{"type":"string"}}},"FormDataContentDisposition":{"type":"object","properties":{"creationDate":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"modificationDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"type":{"type":"string"}}},"Format":{"type":"string","enum":["WSDL","API"]},"GenericNotificationConfigEntity":{"type":"object","properties":{"config":{"type":"string"},"config_type":{"$ref":"#/components/schemas/NotificationConfigType"},"hooks":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"name":{"type":"string"},"notifier":{"type":"string"},"referenceId":{"type":"string"},"referenceType":{"type":"string"},"useSystemProxy":{"type":"boolean"}}},"GithubAuthentication":{"type":"object","properties":{"clientId":{"type":"string"}}},"GoogleAuthentication":{"type":"object","properties":{"clientId":{"type":"string"}}},"GrantedAuthority":{"type":"object","properties":{"authority":{"type":"string"}}},"GroupEntity":{"type":"object","properties":{"apiPrimaryOwner":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"disable_membership_notifications":{"type":"boolean"},"email_invitation":{"type":"boolean"},"event_rules":{"type":"array","items":{"$ref":"#/components/schemas/GroupEventRuleEntity"}},"id":{"type":"string"},"lock_api_role":{"type":"boolean"},"lock_application_role":{"type":"boolean"},"manageable":{"type":"boolean"},"max_invitation":{"type":"integer","format":"int32"},"name":{"type":"string"},"primary_owner":{"type":"boolean"},"roles":{"type":"object","additionalProperties":{"type":"string"}},"system_invitation":{"type":"boolean"},"updated_at":{"type":"string","format":"date-time"}}},"GroupEventRuleEntity":{"type":"object","properties":{"event":{"type":"string"}}},"GroupMappingEntity":{"required":["groups"],"type":"object","properties":{"condition":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}}}},"GroupMemberEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"displayName":{"type":"string"},"id":{"type":"string"},"roles":{"type":"object","additionalProperties":{"type":"string"}},"updated_at":{"type":"string","format":"date-time"}}},"GroupMembership":{"type":"object","properties":{"id":{"type":"string"},"reference":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/MemberRoleEntity"}}}},"GroupSimpleEntity":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"HealthCheckRequest":{"type":"object","properties":{"body":{"type":"string"},"fromRoot":{"type":"boolean"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/HttpHeader"}},"method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]},"path":{"type":"string"}}},"HealthCheckResponse":{"type":"object","properties":{"assertions":{"type":"array","items":{"type":"string"}}}},"HealthCheckService":{"type":"object","properties":{"enabled":{"type":"boolean"},"schedule":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/HealthCheckStep"}}}},"HealthCheckStep":{"type":"object","properties":{"name":{"type":"string"},"request":{"$ref":"#/components/schemas/HealthCheckRequest"},"response":{"$ref":"#/components/schemas/HealthCheckResponse"}}},"HealthcheckField":{"type":"string","enum":["ENDPOINT","GATEWAY"]},"HealthcheckType":{"type":"string","enum":["AVAILABILITY","RESPONSE_TIME"]},"Hook":{"type":"object","properties":{"category":{"type":"string"},"description":{"type":"string"},"hidden":{"type":"boolean"},"label":{"type":"string"},"scope":{"type":"string","enum":["API","APPLICATION","PORTAL","TEMPLATES_FOR_ACTION","TEMPLATES_FOR_ALERT"]},"template":{"type":"string"}}},"HttpClientOptions":{"type":"object","properties":{"clearTextUpgrade":{"type":"boolean"},"connectTimeout":{"type":"integer","format":"int64"},"followRedirects":{"type":"boolean"},"idleTimeout":{"type":"integer","format":"int64"},"keepAlive":{"type":"boolean"},"maxConcurrentConnections":{"type":"integer","format":"int32"},"pipelining":{"type":"boolean"},"readTimeout":{"type":"integer","format":"int64"},"useCompression":{"type":"boolean"},"version":{"type":"string","enum":["HTTP_1_1","HTTP_2"]}}},"HttpClientSslOptions":{"type":"object","properties":{"hostnameVerifier":{"type":"boolean"},"keyStore":{"$ref":"#/components/schemas/KeyStore"},"trustAll":{"type":"boolean"},"trustStore":{"$ref":"#/components/schemas/TrustStore"}}},"HttpDynamicPropertyProviderConfiguration":{"required":["specification","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/DynamicPropertyProviderConfiguration"},{"type":"object","properties":{"url":{"type":"string"},"specification":{"type":"string"},"useSystemProxy":{"type":"boolean"},"method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]},"headers":{"type":"array","items":{"$ref":"#/components/schemas/HttpHeader"}},"body":{"type":"string"}}}]},"HttpHeader":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"HttpHeaders":{"type":"object","properties":{"accept":{"type":"array","items":{"$ref":"#/components/schemas/MediaType"}},"all":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"type":"string"}}},"HttpListenerV4":{"required":["entrypoints","paths","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ListenerV4"},{"type":"object","properties":{"paths":{"type":"array","items":{"$ref":"#/components/schemas/PathV4"}},"pathMappings":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"cors":{"$ref":"#/components/schemas/Cors"},"logging":{"$ref":"#/components/schemas/Logging"}}}]},"HttpProxy":{"type":"object","properties":{"enabled":{"type":"boolean"},"host":{"type":"string"},"password":{"type":"string"},"port":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["HTTP","SOCKS4","SOCKS5"]},"useSystemProxy":{"type":"boolean"},"username":{"type":"string"}}},"HttpRequest":{"type":"object","properties":{"body":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"method":{"type":"string"},"path":{"type":"string"}}},"HttpResponse":{"type":"object","properties":{"body":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"statusCode":{"type":"integer","format":"int32"}}},"HttpSelectorV4":{"required":["path","pathOperator","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Selector"},{"type":"object","properties":{"path":{"type":"string"},"pathOperator":{"type":"string","enum":["STARTS_WITH","EQUALS"]},"methods":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]}}}}]},"IdentityProviderActivationEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"identityProvider":{"type":"string"},"referenceId":{"type":"string"},"referenceType":{"$ref":"#/components/schemas/IdentityProviderActivationReferenceType"}}},"IdentityProviderActivationReferenceType":{"type":"string","enum":["ENVIRONMENT","ORGANIZATION"]},"IdentityProviderEntity":{"type":"object","properties":{"configuration":{"type":"object","additionalProperties":{"type":"object"}},"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"emailRequired":{"type":"boolean"},"enabled":{"type":"boolean"},"groupMappings":{"type":"array","items":{"$ref":"#/components/schemas/GroupMappingEntity"}},"id":{"type":"string"},"name":{"type":"string"},"organization":{"type":"string"},"roleMappings":{"type":"array","items":{"$ref":"#/components/schemas/RoleMappingEntity"}},"syncMappings":{"type":"boolean"},"type":{"$ref":"#/components/schemas/IdentityProviderType"},"updated_at":{"type":"string","format":"date-time"},"userProfileMapping":{"type":"object","additionalProperties":{"type":"string"}}}},"IdentityProviderListItem":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"sync":{"type":"boolean"},"type":{"$ref":"#/components/schemas/IdentityProviderType"},"updated_at":{"type":"string","format":"date-time"}}},"IdentityProviderType":{"type":"string","enum":["GOOGLE","GITHUB","GRAVITEEIO_AM","OIDC"]},"ImportPageEntity":{"required":["type"],"type":"object","properties":{"accessControls":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AccessControlEntity"}},"configuration":{"type":"object","additionalProperties":{"type":"string"}},"excludedAccessControls":{"type":"boolean"},"excluded_groups":{"type":"array","items":{"type":"string"}},"lastContributor":{"type":"string"},"published":{"type":"boolean"},"source":{"$ref":"#/components/schemas/PageSourceEntity"},"type":{"$ref":"#/components/schemas/PageType"},"visibility":{"$ref":"#/components/schemas/Visibility"}}},"ImportSwaggerDescriptorEntity":{"required":["payload"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/Format"},"payload":{"type":"string","description":"The swagger/openapi content."},"type":{"$ref":"#/components/schemas/Type"},"with_documentation":{"type":"boolean","description":"Do you want to create a swagger page in addition to the API ?","example":true},"with_path_mapping":{"type":"boolean","description":"Do you want to create a path mapping for each declared swagger paths in addition to the API ?","example":true},"with_policies":{"type":"array","items":{"type":"string"}},"with_policy_paths":{"type":"boolean","description":"Do you want to create a path (in order to add policies under) for each declared swagger paths in addition to the API ?","example":true}}},"InitialAccessTokenType":{"type":"string","enum":["INITIAL_ACCESS_TOKEN","CLIENT_CREDENTIALS"]},"InstanceEntity":{"type":"object","properties":{"environments":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"environments_hrids":{"type":"array","items":{"type":"string"}},"event":{"type":"string"},"hostname":{"type":"string"},"id":{"type":"string"},"ip":{"type":"string"},"last_heartbeat_at":{"type":"string","format":"date-time"},"organizations_hrids":{"type":"array","items":{"type":"string"}},"plugins":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PluginEntity"}},"port":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/InstanceState"},"stopped_at":{"type":"string","format":"date-time"},"systemProperties":{"type":"object","additionalProperties":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"tenant":{"type":"string"},"version":{"type":"string"}}},"InstanceListItem":{"type":"object","properties":{"event":{"type":"string"},"hostname":{"type":"string"},"id":{"type":"string"},"ip":{"type":"string"},"last_heartbeat_at":{"type":"string","format":"date-time"},"operating_system_name":{"type":"string"},"port":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/InstanceState"},"stopped_at":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"string"}},"tenant":{"type":"string"},"version":{"type":"string"}}},"InstanceState":{"type":"string","enum":["STARTED","UNKNOWN","STOPPED"]},"InvitationEntity":{"type":"object","properties":{"api_role":{"type":"string"},"application_role":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"email":{"type":"string"},"id":{"type":"string"},"reference_id":{"type":"string"},"reference_type":{"$ref":"#/components/schemas/InvitationReferenceType"},"updated_at":{"type":"string","format":"date-time"}}},"InvitationReferenceType":{"type":"string","enum":["API","APPLICATION","GROUP"]},"JKSKeyStore":{"type":"object","allOf":[{"$ref":"#/components/schemas/KeyStore"},{"type":"object","properties":{"path":{"type":"string"},"content":{"type":"string"},"password":{"type":"string"}}}]},"JKSTrustStore":{"type":"object","allOf":[{"$ref":"#/components/schemas/TrustStore"},{"type":"object","properties":{"path":{"type":"string"},"content":{"type":"string"},"password":{"type":"string"}}}]},"JsonNode":{"type":"object"},"JsonPatch":{"required":["jsonPath"],"type":"object","properties":{"jsonPath":{"type":"string"},"operation":{"type":"string","enum":["ADD","REMOVE","REPLACE","TEST"]},"value":{"type":"object"}}},"JupiterMode":{"type":"object","properties":{"enabled":{"type":"boolean"},"isDefault":{"type":"string"}}},"KeyStore":{"type":"object","properties":{"type":{"type":"string","enum":["PEM","PKCS12","JKS","None"]}},"discriminator":{"propertyName":"type","mapping":{"JKS":"#/components/schemas/JKSKeyStore","PEM":"#/components/schemas/PEMKeyStore","PKCS12":"#/components/schemas/PKCS12KeyStore"}}},"LifecycleAction":{"type":"string","enum":["START","STOP"]},"ListStringParam":{"type":"array","items":{"type":"string"}},"ListSubscriptionStatusParam":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionStatus"}},"ListenerV4":{"required":["entrypoints","type"],"type":"object","properties":{"entrypoints":{"type":"array","items":{"$ref":"#/components/schemas/EntrypointV4"}},"type":{"type":"string","enum":["HTTP","SUBSCRIPTION","TCP"]}},"description":"A list of listeners used to describe our you api could be reached.","discriminator":{"propertyName":"type","mapping":{"http":"#/components/schemas/HttpListenerV4","tcp":"#/components/schemas/TcpListenerV4","subscription":"#/components/schemas/SubscriptionListenerV4"}},"oneOf":[{"$ref":"#/components/schemas/HttpListenerV4"},{"$ref":"#/components/schemas/TcpListenerV4"},{"$ref":"#/components/schemas/SubscriptionListenerV4"}]},"LoadBalancer":{"type":"object","properties":{"type":{"type":"string","enum":["ROUND_ROBIN","RANDOM","WEIGHTED_ROUND_ROBIN","WEIGHTED_RANDOM"]}}},"LoadBalancerV4":{"type":"object","properties":{"type":{"type":"string","enum":["ROUND_ROBIN","RANDOM","WEIGHTED_ROUND_ROBIN","WEIGHTED_RANDOM"]}}},"Log":{"type":"object","properties":{"available":{"type":"boolean"},"endpoint":{"type":"string"},"gateway":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"request":{"$ref":"#/components/schemas/Request"},"response":{"$ref":"#/components/schemas/Response"},"responseTime":{"type":"integer","format":"int64"},"state":{"type":"integer","format":"int32"},"success":{"type":"boolean"},"timestamp":{"type":"integer","format":"int64"}}},"Logging":{"type":"object","properties":{"condition":{"type":"string"},"content":{"type":"string","enum":["NONE","HEADERS","PAYLOADS","HEADERS_PAYLOADS"]},"mode":{"type":"string","enum":["NONE","CLIENT","PROXY","CLIENT_PROXY"]},"scope":{"type":"string","enum":["NONE","REQUEST","RESPONSE","REQUEST_RESPONSE"]}}},"Maintenance":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"Management":{"type":"object","properties":{"automaticValidation":{"$ref":"#/components/schemas/Enabled"},"pathBasedApiCreation":{"$ref":"#/components/schemas/Enabled"},"support":{"$ref":"#/components/schemas/Enabled"},"systemRoleEdition":{"$ref":"#/components/schemas/Enabled"},"title":{"type":"string"},"url":{"type":"string"},"userCreation":{"$ref":"#/components/schemas/Enabled"}}},"MediaType":{"type":"object","properties":{"QUALITY_FACTOR_PARAMETER":{"type":"string"},"charset":{"type":"object","properties":{"registered":{"type":"boolean"}}},"concrete":{"type":"boolean"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"qualityFactor":{"type":"number","format":"double"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}}},"MemberEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"displayName":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"permissions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"referenceId":{"type":"string"},"referenceType":{"$ref":"#/components/schemas/MembershipReferenceType"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleEntity"}},"type":{"$ref":"#/components/schemas/MembershipMemberType"},"updated_at":{"type":"string","format":"date-time"}}},"MemberRoleEntity":{"type":"object","properties":{"name":{"type":"string"},"scope":{"$ref":"#/components/schemas/RoleScope"}}},"MembershipListItem":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}}},"MembershipMemberType":{"type":"string","description":"Type's name","example":"USER","enum":["USER","GROUP"]},"MembershipReferenceType":{"type":"string","enum":["APPLICATION","API","GROUP","ENVIRONMENT","ORGANIZATION","PLATFORM"]},"MessageBodyWorkers":{"type":"object"},"MessageChannel":{"type":"string","enum":["MAIL","PORTAL","HTTP"]},"MessageEntity":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/MessageChannel"},"params":{"type":"object","additionalProperties":{"type":"string"}},"recipient":{"$ref":"#/components/schemas/MessageRecipientEntity"},"text":{"type":"string"},"title":{"type":"string"},"useSystemProxy":{"type":"boolean"}}},"MessageRecipientEntity":{"type":"object","properties":{"role_scope":{"type":"string"},"role_value":{"type":"array","items":{"type":"string"}},"url":{"type":"string"}}},"MetadataEntity":{"required":["name"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/MetadataFormat"},"key":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"value":{"type":"string"}}},"MetadataFormat":{"type":"string","enum":["STRING","NUMERIC","BOOLEAN","DATE","MAIL","URL"]},"MetadataPageAuditEntity":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AuditEntity"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"pageElements":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"MissingDataCondition":{"required":["duration"],"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"duration":{"type":"integer","format":"int64"},"timeUnit":{"type":"string","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"]}}}]},"MonitoringCPU":{"type":"object","properties":{"load_average":{"type":"object","additionalProperties":{"type":"object"}},"percent_use":{"type":"integer","format":"int32"}}},"MonitoringData":{"type":"object","properties":{"cpu":{"$ref":"#/components/schemas/MonitoringCPU"},"gc":{"$ref":"#/components/schemas/MonitoringGC"},"jvm":{"$ref":"#/components/schemas/MonitoringJVM"},"process":{"$ref":"#/components/schemas/MonitoringProcess"},"thread":{"$ref":"#/components/schemas/MonitoringThread"}}},"MonitoringGC":{"type":"object","properties":{"old_collection_count":{"type":"integer","format":"int32"},"old_collection_time_in_millis":{"type":"integer","format":"int64"},"young_collection_count":{"type":"integer","format":"int32"},"young_collection_time_in_millis":{"type":"integer","format":"int64"}}},"MonitoringJVM":{"type":"object","properties":{"heap_committed_in_bytes":{"type":"integer","format":"int64"},"heap_max_in_bytes":{"type":"integer","format":"int64"},"heap_used_in_bytes":{"type":"integer","format":"int64"},"heap_used_percent":{"type":"integer","format":"int32"},"non_heap_committed_in_bytes":{"type":"integer","format":"int64"},"non_heap_used_in_bytes":{"type":"integer","format":"int64"},"old_pool_max_in_bytes":{"type":"integer","format":"int64"},"old_pool_peak_max_in_bytes":{"type":"integer","format":"int64"},"old_pool_peak_used_in_bytes":{"type":"integer","format":"int64"},"old_pool_used_in_bytes":{"type":"integer","format":"int64"},"survivor_pool_max_in_bytes":{"type":"integer","format":"int64"},"survivor_pool_peak_max_in_bytes":{"type":"integer","format":"int64"},"survivor_pool_peak_used_in_bytes":{"type":"integer","format":"int64"},"survivor_pool_used_in_bytes":{"type":"integer","format":"int64"},"timestamp":{"type":"integer","format":"int64"},"uptime_in_millis":{"type":"integer","format":"int64"},"young_pool_max_in_bytes":{"type":"integer","format":"int64"},"young_pool_peak_max_in_bytes":{"type":"integer","format":"int64"},"young_pool_peak_used_in_bytes":{"type":"integer","format":"int64"},"young_pool_used_in_bytes":{"type":"integer","format":"int64"}}},"MonitoringProcess":{"type":"object","properties":{"cpu_percent":{"type":"integer","format":"int32"},"max_file_descriptors":{"type":"integer","format":"int32"},"open_file_descriptors":{"type":"integer","format":"int32"}}},"MonitoringThread":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"peak_count":{"type":"integer","format":"int32"}}},"MultiPart":{"type":"object","properties":{"bodyParts":{"type":"array","items":{"$ref":"#/components/schemas/BodyPart"}},"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"}},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"}}},"MultiValueMapStringString":{"type":"object","properties":{"all":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"type":"string"}}},"NewAlertTriggerEntity":{"required":["name","type"],"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}},"dampening":{"$ref":"#/components/schemas/Dampening"},"description":{"maxLength":256,"minLength":0,"type":"string"},"enabled":{"type":"boolean"},"event_rules":{"type":"array","items":{"$ref":"#/components/schemas/AlertEventRuleEntity"}},"filters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"name":{"type":"string"},"notificationPeriods":{"type":"array","items":{"$ref":"#/components/schemas/Period"}},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"reference_id":{"type":"string"},"reference_type":{"$ref":"#/components/schemas/AlertReferenceType"},"severity":{"type":"string","enum":["INFO","WARNING","CRITICAL"]},"source":{"type":"string"},"template":{"type":"boolean"},"type":{"type":"string"}}},"NewApiEntity":{"required":["contextPath","description","endpoint","name","version"],"type":"object","properties":{"contextPath":{"type":"string","description":"API's context path.","example":"/my-awesome-api"},"description":{"type":"string","description":"API's description. A short description of your API.","example":"I can use a hundred characters to describe this API."},"endpoint":{"type":"string","description":"API's first endpoint (target url).","example":"https://local-dc:8081/api"},"flow_mode":{"type":"string","description":"API's flow mode.","example":"BEST_MATCH","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","description":"API's paths. A json representation of the design of each flow.","items":{"$ref":"#/components/schemas/Flow"}},"gravitee":{"type":"string","description":"API's gravitee definition version"},"groups":{"uniqueItems":true,"type":"array","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"name":{"type":"string","description":"Api's name. Duplicate names can exists.","example":"My Api"},"paths":{"type":"array","description":"API's paths. A json representation of the design of each path.","items":{"type":"string","description":"API's paths. A json representation of the design of each path."}},"version":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"}}},"NewApiEntityV4":{"required":["apiVersion","definitionVersion","description","endpointGroups","listeners","name","type"],"type":"object","properties":{"apiVersion":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"},"definitionVersion":{"type":"string","description":"API's gravitee definition version","enum":["1.0.0","2.0.0","4.0.0"]},"description":{"type":"string","description":"API's description. A short description of your API.","example":"I can use a hundred characters to describe this API."},"endpointGroups":{"type":"array","description":"A list of endpoint describing the endpoints to contact.","items":{"$ref":"#/components/schemas/EndpointGroupV4"}},"flowMode":{"type":"string","description":"API's flow mode.","example":"BEST_MATCH","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","description":"A list of flows containing the policies configuration.","items":{"$ref":"#/components/schemas/FlowV4"}},"groups":{"uniqueItems":true,"type":"array","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"listeners":{"type":"array","description":"A list of listeners used to describe our you api could be reached.","items":{"$ref":"#/components/schemas/ListenerV4"}},"name":{"type":"string","description":"API's name. Duplicate names can exists.","example":"My Api"},"tags":{"uniqueItems":true,"type":"array","description":"The list of sharding tags associated with this API.","example":"public, private","items":{"type":"string","description":"The list of sharding tags associated with this API.","example":"public, private"}},"type":{"type":"string","description":"API's type","example":"async","enum":["SYNC","ASYNC"]}}},"NewApiHeaderEntity":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"NewApiMetadataEntity":{"required":["name"],"type":"object","properties":{"apiId":{"type":"string"},"defaultValue":{"type":"string"},"format":{"$ref":"#/components/schemas/MetadataFormat"},"hidden":{"type":"boolean"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"value":{"type":"string"}}},"NewApiQualityRuleEntity":{"type":"object","properties":{"api":{"type":"string"},"checked":{"type":"boolean"},"quality_rule":{"type":"string"}}},"NewApplicationEntity":{"required":["description","name"],"type":"object","properties":{"api_key_mode":{"$ref":"#/components/schemas/ApiKeyMode"},"background":{"type":"string"},"clientId":{"type":"string"},"description":{"type":"string","description":"Application's description. A short description of your App.","example":"I can use a hundred characters to describe this App."},"domain":{"type":"string","description":"Domain used by the application, if relevant","example":"https://my-app.com"},"groups":{"uniqueItems":true,"type":"array","description":"Application groups. Used to add teams to your application.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"Application groups. Used to add teams to your application.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"name":{"type":"string","description":"Application's name. Duplicate names can exists.","example":"My App"},"picture":{"type":"string"},"settings":{"$ref":"#/components/schemas/ApplicationSettings"},"type":{"type":"string","description":"a string to describe the type of your app.","example":"iOS"}}},"NewApplicationMetadataEntity":{"required":["name"],"type":"object","properties":{"applicationId":{"type":"string"},"defaultValue":{"type":"string"},"format":{"$ref":"#/components/schemas/MetadataFormat"},"hidden":{"type":"boolean"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"value":{"type":"string"}}},"NewCategoryEntity":{"required":["name"],"type":"object","properties":{"background":{"type":"string"},"description":{"type":"string"},"hidden":{"type":"boolean"},"highlightApi":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"order":{"type":"integer","format":"int32"},"page":{"type":"string"},"picture":{"type":"string"}}},"NewClientRegistrationProviderEntity":{"required":["discovery_endpoint","initial_access_token_type","name"],"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"description":{"type":"string"},"discovery_endpoint":{"type":"string"},"initial_access_token":{"type":"string"},"initial_access_token_type":{"$ref":"#/components/schemas/InitialAccessTokenType"},"name":{"maxLength":2147483647,"minLength":3,"type":"string"},"renew_client_secret_endpoint":{"type":"string"},"renew_client_secret_method":{"type":"string"},"renew_client_secret_support":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}},"software_id":{"type":"string"}}},"NewDashboardEntity":{"required":["name","reference_id","reference_type"],"type":"object","properties":{"definition":{"type":"string"},"enabled":{"type":"boolean"},"name":{"maxLength":64,"minLength":0,"type":"string"},"query_filter":{"type":"string"},"reference_id":{"maxLength":64,"minLength":0,"type":"string"},"reference_type":{"$ref":"#/components/schemas/DashboardReferenceType"}}},"NewDictionaryEntity":{"required":["name","type"],"type":"object","properties":{"description":{"type":"string"},"name":{"maxLength":2147483647,"minLength":3,"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}},"provider":{"$ref":"#/components/schemas/DictionaryProviderEntity"},"trigger":{"$ref":"#/components/schemas/DictionaryTriggerEntity"},"type":{"$ref":"#/components/schemas/DictionaryType"}}},"NewEntryPointEntity":{"required":["tags","value"],"type":"object","properties":{"tags":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"type":"string"}},"value":{"maxLength":2147483647,"minLength":1,"type":"string"}}},"NewExternalUserEntity":{"required":["email"],"type":"object","properties":{"customFields":{"type":"object","additionalProperties":{"type":"object"}},"email":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"newsletter":{"type":"boolean"},"picture":{"type":"string"},"source":{"type":"string"},"sourceId":{"type":"string"}}},"NewGroupEntity":{"required":["name"],"type":"object","properties":{"disable_membership_notifications":{"type":"boolean"},"email_invitation":{"type":"boolean"},"event_rules":{"type":"array","items":{"$ref":"#/components/schemas/GroupEventRuleEntity"}},"lock_api_role":{"type":"boolean"},"lock_application_role":{"type":"boolean"},"max_invitation":{"type":"integer","format":"int32"},"name":{"type":"string"},"system_invitation":{"type":"boolean"}}},"NewIdentityProviderEntity":{"required":["configuration","name","type"],"type":"object","properties":{"configuration":{"type":"object","additionalProperties":{"type":"object"}},"description":{"type":"string"},"emailRequired":{"type":"boolean"},"enabled":{"type":"boolean"},"name":{"maxLength":2147483647,"minLength":2,"type":"string"},"syncMappings":{"type":"boolean"},"type":{"$ref":"#/components/schemas/IdentityProviderType"},"userProfileMapping":{"type":"object","additionalProperties":{"type":"string"}}}},"NewInvitationEntity":{"required":["email","reference_id","reference_type"],"type":"object","properties":{"api_role":{"type":"string"},"application_role":{"type":"string"},"email":{"type":"string"},"reference_id":{"type":"string"},"reference_type":{"$ref":"#/components/schemas/InvitationReferenceType"}}},"NewMetadataEntity":{"required":["name"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/MetadataFormat"},"hidden":{"type":"boolean"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"value":{"type":"string"}}},"NewPageEntity":{"required":["name","type"],"type":"object","properties":{"accessControls":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AccessControlEntity"}},"attached_media":{"type":"array","items":{"$ref":"#/components/schemas/PageMediaEntity"}},"configuration":{"type":"object","additionalProperties":{"type":"string"}},"content":{"type":"string"},"crossId":{"type":"string"},"excludedAccessControls":{"type":"boolean"},"excluded_groups":{"type":"array","items":{"type":"string"}},"homepage":{"type":"boolean"},"lastContributor":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"order":{"type":"integer","format":"int32"},"parentId":{"type":"string"},"published":{"type":"boolean"},"source":{"$ref":"#/components/schemas/PageSourceEntity"},"type":{"$ref":"#/components/schemas/PageType"},"useAutoFetch":{"type":"boolean"},"visibility":{"$ref":"#/components/schemas/Visibility"}}},"NewPlanEntity":{"required":["description","flows","name","paths","security","status","type","validation"],"type":"object","properties":{"api":{"type":"string"},"characteristics":{"type":"array","items":{"type":"string"}},"comment_message":{"type":"string"},"comment_required":{"type":"boolean"},"crossId":{"type":"string"},"description":{"type":"string"},"excluded_groups":{"type":"array","items":{"type":"string"}},"flows":{"type":"array","items":{"$ref":"#/components/schemas/Flow"}},"general_conditions":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"paths":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Rule"}}},"security":{"$ref":"#/components/schemas/PlanSecurityType"},"securityDefinition":{"type":"string"},"selection_rule":{"type":"string"},"status":{"$ref":"#/components/schemas/PlanStatus"},"tags":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/PlanType"},"validation":{"$ref":"#/components/schemas/PlanValidationType"}}},"NewPlanEntityV4":{"required":["description","flows","name","status","type","validation"],"type":"object","properties":{"apiId":{"type":"string"},"characteristics":{"type":"array","items":{"type":"string"}},"commentMessage":{"type":"string"},"commentRequired":{"type":"boolean"},"crossId":{"type":"string"},"description":{"type":"string"},"excludedGroups":{"type":"array","items":{"type":"string"}},"flows":{"type":"array","items":{"$ref":"#/components/schemas/FlowV4"}},"generalConditions":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"security":{"$ref":"#/components/schemas/PlanSecurityV4"},"selectionRule":{"type":"string"},"status":{"type":"string","enum":["STAGING","PUBLISHED","DEPRECATED","CLOSED"]},"tags":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/PlanTypeV4"},"validation":{"$ref":"#/components/schemas/PlanValidationTypeV4"}}},"NewPreRegisterUserEntity":{"required":["email"],"type":"object","properties":{"customFields":{"type":"object","additionalProperties":{"type":"object"}},"email":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"newsletter":{"type":"boolean"},"picture":{"type":"string"},"service":{"type":"boolean"},"source":{"type":"string"},"sourceId":{"type":"string"}}},"NewQualityRuleEntity":{"required":["description","name"],"type":"object","properties":{"description":{"maxLength":256,"minLength":0,"type":"string"},"name":{"maxLength":64,"minLength":0,"type":"string"},"weight":{"maximum":99999,"minimum":0,"type":"integer","format":"int32"}}},"NewRatingAnswerEntity":{"type":"object","properties":{"comment":{"maxLength":1024,"minLength":0,"type":"string"},"ratingId":{"type":"string"}}},"NewRatingEntity":{"type":"object","properties":{"api":{"type":"string"},"comment":{"maxLength":1024,"minLength":0,"type":"string"},"rate":{"type":"string","format":"byte"},"title":{"maxLength":64,"minLength":0,"type":"string"}}},"NewRoleEntity":{"required":["name","scope"],"type":"object","properties":{"default":{"type":"boolean"},"description":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"permissions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"scope":{"$ref":"#/components/schemas/RoleScope"}}},"NewSubscriptionConfigurationEntity":{"type":"object","properties":{"configuration":{"type":"string"},"filter":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"NewSubscriptionEntity":{"type":"object","properties":{"application":{"type":"string"},"configuration":{"type":"string"},"filter":{"type":"string"},"generalConditionsAccepted":{"type":"boolean"},"generalConditionsContentRevision":{"$ref":"#/components/schemas/PageRevisionId"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"plan":{"type":"string"},"request":{"type":"string"}}},"NewTagEntity":{"required":["name"],"type":"object","properties":{"description":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"restricted_groups":{"type":"array","items":{"type":"string"}}}},"NewTenantEntity":{"required":["name"],"type":"object","properties":{"description":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"}}},"NewThemeEntity":{"required":["name"],"type":"object","properties":{"backgroundImage":{"type":"string"},"definition":{"$ref":"#/components/schemas/ThemeDefinition"},"enabled":{"type":"boolean"},"favicon":{"type":"string"},"logo":{"type":"string"},"name":{"maxLength":64,"minLength":1,"type":"string"},"optionalLogo":{"type":"string"}}},"NewTicketEntity":{"required":["content","subject"],"type":"object","properties":{"api":{"type":"string"},"application":{"type":"string"},"content":{"type":"string"},"copyToSender":{"type":"boolean"},"subject":{"type":"string"}}},"NewTokenEntity":{"required":["name"],"type":"object","properties":{"name":{"maxLength":64,"minLength":1,"type":"string"}}},"NewTopApiEntity":{"type":"object","properties":{"api":{"type":"string"}}},"Newsletter":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"NoneKeyStore":{"type":"object","allOf":[{"$ref":"#/components/schemas/KeyStore"}]},"NoneTrustStore":{"type":"object","allOf":[{"$ref":"#/components/schemas/TrustStore"}]},"Notification":{"type":"object","properties":{"configuration":{"type":"string"},"periods":{"type":"array","items":{"$ref":"#/components/schemas/Period"}},"type":{"type":"string"}}},"NotificationConfigType":{"type":"string","enum":["PORTAL","GENERIC"]},"NotificationTemplateEntity":{"type":"object","properties":{"content":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"enabled":{"type":"boolean"},"hook":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"scope":{"type":"string"},"title":{"type":"string"},"type":{"$ref":"#/components/schemas/NotificationTemplateType"},"updated_at":{"type":"string","format":"date-time"}}},"NotificationTemplateType":{"type":"string","enum":["EMAIL","PORTAL"]},"NotifierEntity":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"plugin":{"$ref":"#/components/schemas/PluginEntity"},"version":{"type":"string"}}},"NotifierListItem":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"schema":{"type":"string"},"version":{"type":"string"}}},"OAuth2Authentication":{"type":"object","properties":{"clientId":{"type":"string"}}},"OAuthClientSettings":{"type":"object","properties":{"application_type":{"type":"string"},"client_id":{"type":"string"},"client_secret":{"type":"string"},"client_uri":{"type":"string"},"grant_types":{"type":"array","items":{"type":"string"}},"logo_uri":{"type":"string"},"redirect_uris":{"type":"array","items":{"type":"string"}},"renew_client_secret_supported":{"type":"boolean"},"response_types":{"type":"array","items":{"type":"string"}}}},"OpenAPIDocType":{"type":"object","properties":{"defaultType":{"type":"string"},"redoc":{"$ref":"#/components/schemas/Enabled"},"swagger":{"$ref":"#/components/schemas/Enabled"}}},"OpenAPIDocViewer":{"type":"object","properties":{"openAPIDocType":{"$ref":"#/components/schemas/OpenAPIDocType"}}},"OrganizationEntity":{"required":["name"],"type":"object","properties":{"cockpitId":{"type":"string"},"description":{"type":"string"},"domainRestrictions":{"type":"array","items":{"type":"string"}},"flowMode":{"type":"string","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","items":{"$ref":"#/components/schemas/Flow"}},"hrids":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"}}},"OrganizationFlowConfiguration":{"type":"object","properties":{"has_policies":{"type":"boolean"}}},"PEMKeyStore":{"type":"object","allOf":[{"$ref":"#/components/schemas/KeyStore"},{"type":"object","properties":{"keyPath":{"type":"string"},"keyContent":{"type":"string"},"certPath":{"type":"string"},"certContent":{"type":"string"}}}]},"PEMTrustStore":{"type":"object","allOf":[{"$ref":"#/components/schemas/TrustStore"},{"type":"object","properties":{"path":{"type":"string"},"content":{"type":"string"}}}]},"PKCS12KeyStore":{"type":"object","allOf":[{"$ref":"#/components/schemas/KeyStore"},{"type":"object","properties":{"path":{"type":"string"},"content":{"type":"string"},"password":{"type":"string"}}}]},"PKCS12TrustStore":{"type":"object","allOf":[{"$ref":"#/components/schemas/TrustStore"},{"type":"object","properties":{"path":{"type":"string"},"content":{"type":"string"},"password":{"type":"string"}}}]},"Page":{"type":"object","properties":{"current":{"type":"integer","format":"int32"},"per_page":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"total_elements":{"type":"integer","format":"int32"},"total_pages":{"type":"integer","format":"int32"}}},"PageEntity":{"type":"object","properties":{"accessControls":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AccessControlEntity"}},"attached_media":{"type":"array","items":{"$ref":"#/components/schemas/PageMediaEntity"}},"configuration":{"type":"object","additionalProperties":{"type":"string"}},"content":{"type":"string"},"contentRevisionId":{"$ref":"#/components/schemas/PageRevisionId"},"contentType":{"type":"string"},"crossId":{"type":"string"},"excludedAccessControls":{"type":"boolean"},"excluded_groups":{"type":"array","items":{"type":"string"}},"generalConditions":{"type":"boolean","readOnly":true},"homepage":{"type":"boolean"},"id":{"type":"string"},"lastContributor":{"type":"string"},"lastModificationDate":{"type":"string","format":"date-time"},"messages":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"parentId":{"type":"string"},"parentPath":{"type":"string"},"published":{"type":"boolean"},"source":{"$ref":"#/components/schemas/PageSourceEntity"},"translations":{"type":"array","items":{"$ref":"#/components/schemas/PageEntity"}},"type":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"}}},"PageInstanceListItem":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/InstanceListItem"}},"pageElements":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageMediaEntity":{"type":"object","properties":{"attachedAt":{"type":"string","format":"date-time"},"mediaHash":{"type":"string"},"mediaName":{"type":"string"}}},"PageRatingEntity":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/RatingEntity"}},"pageElements":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageRevisionId":{"type":"object","properties":{"pageId":{"type":"string"},"revision":{"type":"integer","format":"int32"}}},"PageSourceEntity":{"type":"object","properties":{"configuration":{"type":"string"},"type":{"type":"string"}}},"PageType":{"type":"string","enum":["ASCIIDOC","ASYNCAPI","MARKDOWN","MARKDOWN_TEMPLATE","SWAGGER","FOLDER","LINK","ROOT","SYSTEM_FOLDER","TRANSLATION"]},"PagedResultApiListItem":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiListItem"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object"}}},"page":{"$ref":"#/components/schemas/Page"}}},"PagedResultGroupMemberEntity":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupMemberEntity"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object"}}},"page":{"$ref":"#/components/schemas/Page"}}},"ParameterizedHeader":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"}},"value":{"type":"string"}}},"PathOperator":{"type":"object","properties":{"operator":{"type":"string","enum":["STARTS_WITH","EQUALS"]},"path":{"type":"string"}}},"PathV4":{"required":["path"],"type":"object","properties":{"host":{"type":"string"},"overrideAccess":{"type":"boolean"},"path":{"type":"string"}}},"Payload":{"required":["clientId","code","redirectUri"],"type":"object","properties":{"clientId":{"type":"string"},"code":{"type":"string"},"redirectUri":{"type":"string"},"state":{"type":"string"}}},"Period":{"required":["beginHour","endHour","zoneId"],"type":"object","properties":{"beginHour":{"type":"integer","format":"int32"},"days":{"type":"array","items":{"type":"integer","format":"int32"}},"endHour":{"type":"integer","format":"int32"},"zoneId":{"type":"string"}}},"PermissionMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"maxLength":1,"minLength":1,"type":"string"}}},"Plan":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"security":{"$ref":"#/components/schemas/PlanSecurityType"}}},"PlanEntity":{"required":["description","flows","name","paths","security","status","type","validation"],"type":"object","properties":{"api":{"type":"string"},"characteristics":{"type":"array","items":{"type":"string"}},"closed_at":{"type":"string","format":"date-time"},"comment_message":{"type":"string"},"comment_required":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"crossId":{"type":"string"},"description":{"type":"string"},"excluded_groups":{"type":"array","items":{"type":"string"}},"flows":{"type":"array","items":{"$ref":"#/components/schemas/Flow"}},"general_conditions":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"paths":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Rule"}}},"published_at":{"type":"string","format":"date-time"},"security":{"$ref":"#/components/schemas/PlanSecurityType"},"securityDefinition":{"type":"string"},"selection_rule":{"type":"string"},"status":{"$ref":"#/components/schemas/PlanStatus"},"tags":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/PlanType"},"updated_at":{"type":"string","format":"date-time"},"validation":{"$ref":"#/components/schemas/PlanValidationType"}},"description":"a list of plans with flows (the policies configuration)"},"PlanEntityV4":{"type":"object","properties":{"apiId":{"type":"string"},"characteristics":{"type":"array","items":{"type":"string"}},"closedAt":{"type":"string","format":"date-time"},"commentMessage":{"type":"string"},"commentRequired":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"crossId":{"type":"string"},"description":{"type":"string"},"excludedGroups":{"type":"array","items":{"type":"string"}},"flows":{"type":"array","items":{"$ref":"#/components/schemas/FlowV4"}},"generalConditions":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"planSecurity":{"$ref":"#/components/schemas/PlanSecurityV4"},"planStatus":{"type":"string","enum":["STAGING","PUBLISHED","DEPRECATED","CLOSED"]},"planValidation":{"$ref":"#/components/schemas/PlanValidationTypeV4"},"publishedAt":{"type":"string","format":"date-time"},"security":{"$ref":"#/components/schemas/PlanSecurityV4"},"selectionRule":{"type":"string"},"status":{"type":"string","enum":["STAGING","PUBLISHED","DEPRECATED","CLOSED"]},"tags":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/PlanTypeV4"},"updatedAt":{"type":"string","format":"date-time"},"validation":{"$ref":"#/components/schemas/PlanValidationTypeV4"}},"description":"A list of plans to apply on the API"},"PlanSecurity":{"type":"object","properties":{"apikey":{"$ref":"#/components/schemas/Enabled"},"customApiKey":{"$ref":"#/components/schemas/Enabled"},"jwt":{"$ref":"#/components/schemas/Enabled"},"keyless":{"$ref":"#/components/schemas/Enabled"},"oauth2":{"$ref":"#/components/schemas/Enabled"},"sharedApiKey":{"$ref":"#/components/schemas/Enabled"}}},"PlanSecurityEntity":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"policy":{"type":"string"}}},"PlanSecurityParam":{"type":"array","items":{"$ref":"#/components/schemas/PlanSecurityType"}},"PlanSecurityParamV4":{"type":"array","items":{"$ref":"#/components/schemas/PlanSecurityTypeV4"}},"PlanSecurityType":{"type":"string","enum":["KEY_LESS","API_KEY","OAUTH2","JWT","SUBSCRIPTION"]},"PlanSecurityTypeV4":{"type":"string","enum":["key-less","api-key","oauth2","jwt","subscription"]},"PlanSecurityV4":{"required":["type"],"type":"object","properties":{"configuration":{"type":"object"},"type":{"type":"string"}}},"PlanSettings":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/PlanSecurity"}}},"PlanStatus":{"type":"string","enum":["STAGING","PUBLISHED","CLOSED","DEPRECATED"]},"PlanStatusParam":{"type":"array","items":{"$ref":"#/components/schemas/PlanStatus"}},"PlanStatusParamV4":{"type":"array","items":{"type":"string","default":"PUBLISHED","enum":["STAGING","PUBLISHED","DEPRECATED","CLOSED"]}},"PlanType":{"type":"string","enum":["API","CATALOG"]},"PlanTypeV4":{"type":"string","enum":["API","CATALOG"]},"PlanValidationType":{"type":"string","enum":["AUTO","MANUAL"]},"PlanValidationTypeV4":{"type":"string","enum":["AUTO","MANUAL"]},"PlansConfigurationEntity":{"type":"object","properties":{"security":{"type":"array","items":{"$ref":"#/components/schemas/PlanSecurityEntity"}}}},"PlatformPluginEntity":{"type":"object","properties":{"category":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}}},"PlatformRequestItem":{"type":"object","properties":{"api":{"type":"string"},"application":{"type":"string"},"endpoint":{"type":"boolean"},"id":{"type":"string"},"method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]},"path":{"type":"string"},"plan":{"type":"string"},"responseTime":{"type":"integer","format":"int64"},"status":{"type":"integer","format":"int32"},"timestamp":{"type":"integer","format":"int64"},"transactionId":{"type":"string"},"user":{"type":"string"}}},"PlatformRequestItemSearchLogResponse":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/PlatformRequestItem"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"total":{"type":"integer","format":"int64"}}},"PluginEntity":{"type":"object","properties":{"dependencies":{"type":"array","items":{"type":"string","format":"url"}},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"plugin":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}}},"PolicyDevelopmentEntity":{"type":"object","properties":{"class":{"type":"string"},"configuration_class":{"type":"string"},"on_request_method":{"type":"string"},"on_response_method":{"type":"string"}}},"PolicyEntity":{"type":"object","properties":{"category":{"type":"string"},"description":{"type":"string"},"dev":{"$ref":"#/components/schemas/PolicyDevelopmentEntity"},"id":{"type":"string"},"name":{"type":"string"},"plugin":{"$ref":"#/components/schemas/PluginEntity"},"type":{"$ref":"#/components/schemas/PolicyType"},"version":{"type":"string"}}},"PolicyListItem":{"type":"object","properties":{"category":{"type":"string"},"description":{"type":"string"},"documentation":{"type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"onRequest":{"type":"boolean"},"onResponse":{"type":"boolean"},"schema":{"type":"string"},"type":{"$ref":"#/components/schemas/PolicyType"},"version":{"type":"string"}}},"PolicyType":{"type":"string","enum":["REQUEST","RESPONSE","REQUEST_RESPONSE"]},"Portal":{"type":"object","properties":{"analytics":{"$ref":"#/components/schemas/PortalAnalytics"},"apikeyHeader":{"type":"string"},"apis":{"$ref":"#/components/schemas/PortalApis"},"entrypoint":{"type":"string"},"homepageTitle":{"type":"string"},"rating":{"$ref":"#/components/schemas/PortalRating"},"support":{"$ref":"#/components/schemas/Enabled"},"uploadMedia":{"$ref":"#/components/schemas/PortalUploadMedia"},"url":{"type":"string"},"userCreation":{"$ref":"#/components/schemas/PortalUserCreation"}}},"PortalAnalytics":{"type":"object","properties":{"enabled":{"type":"boolean"},"trackingId":{"type":"string"}}},"PortalApis":{"type":"object","properties":{"apiHeaderShowCategories":{"$ref":"#/components/schemas/Enabled"},"apiHeaderShowTags":{"$ref":"#/components/schemas/Enabled"},"categoryMode":{"$ref":"#/components/schemas/Enabled"},"promotedApiMode":{"$ref":"#/components/schemas/Enabled"},"tilesMode":{"$ref":"#/components/schemas/Enabled"}}},"PortalApplicationSettings":{"type":"object","properties":{"registration":{"$ref":"#/components/schemas/ClientRegistration"},"types":{"$ref":"#/components/schemas/ApplicationTypes"}}},"PortalAuthentication":{"type":"object","properties":{"forceLogin":{"$ref":"#/components/schemas/Enabled"},"github":{"$ref":"#/components/schemas/GithubAuthentication"},"google":{"$ref":"#/components/schemas/GoogleAuthentication"},"localLogin":{"$ref":"#/components/schemas/Enabled"},"oauth2":{"$ref":"#/components/schemas/OAuth2Authentication"}}},"PortalConfigEntity":{"type":"object","properties":{"analytics":{"$ref":"#/components/schemas/Analytics"},"api":{"$ref":"#/components/schemas/Api"},"apiQualityMetrics":{"$ref":"#/components/schemas/ApiQualityMetrics"},"apiReview":{"$ref":"#/components/schemas/ApiReview"},"application":{"$ref":"#/components/schemas/PortalApplicationSettings"},"authentication":{"$ref":"#/components/schemas/PortalAuthentication"},"company":{"$ref":"#/components/schemas/Company"},"dashboards":{"$ref":"#/components/schemas/Dashboards"},"documentation":{"$ref":"#/components/schemas/Documentation"},"openAPIDocViewer":{"$ref":"#/components/schemas/OpenAPIDocViewer"},"plan":{"$ref":"#/components/schemas/PlanSettings"},"portal":{"$ref":"#/components/schemas/Portal"},"reCaptcha":{"$ref":"#/components/schemas/PortalReCaptcha"},"scheduler":{"$ref":"#/components/schemas/PortalScheduler"}}},"PortalCors":{"type":"object","properties":{"allowHeaders":{"type":"array","items":{"type":"string"}},"allowMethods":{"type":"array","items":{"type":"string"}},"allowOrigin":{"type":"array","items":{"type":"string"}},"exposedHeaders":{"type":"array","items":{"type":"string"}},"maxAge":{"type":"integer","format":"int32"}}},"PortalNotificationConfigEntity":{"type":"object","properties":{"config_type":{"$ref":"#/components/schemas/NotificationConfigType"},"hooks":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"referenceId":{"type":"string"},"referenceType":{"type":"string"},"user":{"type":"string"}}},"PortalNotificationEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"id":{"type":"string"},"message":{"type":"string"},"title":{"type":"string"}}},"PortalNotificationPageResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalNotificationEntity"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object"}}},"page":{"$ref":"#/components/schemas/Page"}}},"PortalRating":{"type":"object","properties":{"comment":{"$ref":"#/components/schemas/RatingComment"},"enabled":{"type":"boolean"}}},"PortalReCaptcha":{"type":"object","properties":{"enabled":{"type":"boolean"},"siteKey":{"type":"string"}}},"PortalScheduler":{"type":"object","properties":{"notifications":{"type":"integer","format":"int32"},"tasks":{"type":"integer","format":"int32"}}},"PortalSettingsEntity":{"type":"object","properties":{"analytics":{"$ref":"#/components/schemas/Analytics"},"api":{"$ref":"#/components/schemas/Api"},"apiQualityMetrics":{"$ref":"#/components/schemas/ApiQualityMetrics"},"apiReview":{"$ref":"#/components/schemas/ApiReview"},"application":{"$ref":"#/components/schemas/PortalApplicationSettings"},"authentication":{"$ref":"#/components/schemas/PortalAuthentication"},"company":{"$ref":"#/components/schemas/Company"},"cors":{"$ref":"#/components/schemas/PortalCors"},"dashboards":{"$ref":"#/components/schemas/Dashboards"},"documentation":{"$ref":"#/components/schemas/Documentation"},"email":{"$ref":"#/components/schemas/Email"},"metadata":{"type":"object","properties":{"all":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"type":"string"}},"readOnly":true},"openAPIDocViewer":{"$ref":"#/components/schemas/OpenAPIDocViewer"},"plan":{"$ref":"#/components/schemas/PlanSettings"},"portal":{"$ref":"#/components/schemas/Portal"},"reCaptcha":{"$ref":"#/components/schemas/PortalReCaptcha"},"scheduler":{"$ref":"#/components/schemas/PortalScheduler"}}},"PortalUploadMedia":{"type":"object","properties":{"enabled":{"type":"boolean"},"maxSizeInOctet":{"type":"integer","format":"int32"}}},"PortalUserCreation":{"type":"object","properties":{"automaticValidation":{"$ref":"#/components/schemas/Enabled"},"enabled":{"type":"boolean"}}},"PrimaryOwnerEntity":{"type":"object","properties":{"displayName":{"type":"string","description":"The user or group display name.","example":"John Doe"},"email":{"type":"string","description":"The user or group email.","example":"contact@gravitee.io"},"id":{"type":"string","description":"The user or group id.","example":"005197cc-cc84-86a6-a75a-88f9772c67db"},"type":{"type":"string","description":"The primary owner type","example":"USER"}},"description":"The user with role PRIMARY_OWNER on this API."},"ProcessSubscriptionEntity":{"required":["accepted"],"type":"object","properties":{"accepted":{"type":"boolean"},"customApiKey":{"type":"string"},"ending_at":{"type":"string","format":"date-time"},"id":{"type":"string"},"reason":{"type":"string"},"starting_at":{"type":"string","format":"date-time"}}},"Projection":{"type":"object","properties":{"type":{"type":"string","enum":["PROPERTY"]}},"discriminator":{"propertyName":"type"}},"PromotionEntity":{"type":"object","properties":{"apiDefinition":{"type":"string"},"apiId":{"type":"string"},"author":{"$ref":"#/components/schemas/PromotionEntityAuthor"},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"sourceEnvCockpitId":{"type":"string"},"sourceEnvName":{"type":"string"},"status":{"$ref":"#/components/schemas/PromotionEntityStatus"},"targetApiId":{"type":"string"},"targetEnvCockpitId":{"type":"string"},"targetEnvName":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}}},"PromotionEntityAuthor":{"type":"object","properties":{"displayName":{"type":"string"},"email":{"type":"string"},"picture":{"type":"string"},"source":{"type":"string"},"sourceId":{"type":"string"},"userId":{"type":"string"}}},"PromotionEntityStatus":{"type":"string","enum":["CREATED","TO_BE_VALIDATED","ACCEPTED","REJECTED","ERROR"]},"PromotionRequestEntity":{"type":"object","properties":{"targetEnvCockpitId":{"type":"string"},"targetEnvName":{"type":"string"}}},"PromotionTargetEntity":{"required":["installationId","name","organizationId"],"type":"object","properties":{"description":{"type":"string"},"hrids":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"installationId":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"organizationId":{"type":"string"}}},"Property":{"required":["key","value"],"type":"object","properties":{"dynamic":{"type":"boolean"},"encrypted":{"type":"boolean"},"key":{"type":"string"},"value":{"type":"string"}},"description":"A dictionary (could be dynamic) of properties available in the API context."},"PropertyEntity":{"required":["key","value"],"type":"object","properties":{"dynamic":{"type":"boolean"},"encryptable":{"type":"boolean"},"encrypted":{"type":"boolean"},"key":{"type":"string"},"value":{"type":"string"}},"description":"A dictionary (could be dynamic) of properties available in the API context."},"PropertyEntityV4":{"required":["key","value"],"type":"object","properties":{"dynamic":{"type":"boolean"},"encryptable":{"type":"boolean"},"encrypted":{"type":"boolean"},"key":{"type":"string"},"value":{"type":"string"}},"description":"A dictionary (could be dynamic) of properties available in the API context."},"PropertyProjection":{"required":["property"],"type":"object","allOf":[{"$ref":"#/components/schemas/Projection"},{"type":"object","properties":{"property":{"type":"string"}}}]},"PropertyV4":{"required":["key","value"],"type":"object","properties":{"dynamic":{"type":"boolean"},"encrypted":{"type":"boolean"},"key":{"type":"string"},"value":{"type":"string"}},"description":"A dictionary (could be dynamic) of properties available in the API context."},"Proxy":{"type":"object","properties":{"cors":{"$ref":"#/components/schemas/Cors"},"failover":{"$ref":"#/components/schemas/Failover"},"groups":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/EndpointGroup"}},"logging":{"$ref":"#/components/schemas/Logging"},"preserve_host":{"type":"boolean"},"strip_context_path":{"type":"boolean"},"virtual_hosts":{"type":"array","items":{"$ref":"#/components/schemas/VirtualHost"}}},"description":"API's definition."},"QualityRuleEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"weight":{"type":"integer","format":"int32"}}},"RangesParam":{"type":"array","items":{"type":"string"}},"RateCondition":{"required":["comparison","duration","operator","threshold"],"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"operator":{"type":"string","enum":["LT","LTE","GTE","GT"]},"threshold":{"type":"number","format":"double"},"comparison":{"$ref":"#/components/schemas/SingleValueCondition"},"duration":{"type":"integer","format":"int64"},"timeUnit":{"type":"string","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"]},"sampleSize":{"type":"integer","format":"int32"}}}]},"RatingAnswerEntity":{"type":"object","properties":{"comment":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"user":{"type":"string"},"userDisplayName":{"type":"string"}}},"RatingComment":{"type":"object","properties":{"mandatory":{"type":"boolean"}}},"RatingEntity":{"type":"object","properties":{"answers":{"type":"array","items":{"$ref":"#/components/schemas/RatingAnswerEntity"}},"api":{"type":"string"},"comment":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"rate":{"type":"string","format":"byte"},"title":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"user":{"type":"string"},"userDisplayName":{"type":"string"}}},"RatingSummaryEntity":{"type":"object","properties":{"api":{"type":"string"},"averageRate":{"type":"number","format":"double"},"numberOfRatings":{"type":"integer","format":"int32"},"numberOfRatingsByRate":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}}}},"RegisterUserEntity":{"required":["firstname","lastname","password","token"],"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"password":{"type":"string"},"token":{"type":"string"}}},"Request":{"type":"object","properties":{"body":{"type":"string"},"headers":{"type":"object","properties":{"accept":{"type":"array","items":{"$ref":"#/components/schemas/MediaType"}},"all":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"type":"string"}}},"method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]},"uri":{"type":"string"}}},"ResetPasswordUserEntity":{"required":["firstname","lastname","password","token"],"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"password":{"type":"string"},"token":{"type":"string"}}},"Resource":{"required":["configuration","name","type"],"type":"object","properties":{"configuration":{"type":"object"},"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"}},"description":"The list of API resources used by policies like cache resources or oauth2"},"ResourceListItem":{"type":"object","properties":{"description":{"type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"schema":{"type":"string"},"version":{"type":"string"}}},"ResourceV4":{"required":["configuration","name","type"],"type":"object","properties":{"configuration":{"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"}},"description":"The list of API resources used by policies like cache resources or oauth2"},"Response":{"type":"object","properties":{"body":{"type":"string"},"headers":{"type":"object","properties":{"accept":{"type":"array","items":{"$ref":"#/components/schemas/MediaType"}},"all":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"type":"string"}}},"status":{"type":"integer","format":"int32"}}},"ResponseTemplate":{"type":"object","properties":{"body":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"status":{"type":"integer","format":"int32"}},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-ky is missing, ..."},"ResponseTemplateV4":{"type":"object","properties":{"body":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"statusCode":{"type":"integer","format":"int32"}},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-key is missing, ..."},"ReviewAction":{"type":"string","enum":["ASK","ACCEPT","REJECT"]},"ReviewEntity":{"type":"object","properties":{"message":{"maxLength":500,"minLength":0,"type":"string"}}},"RoleEntity":{"required":["id"],"type":"object","properties":{"apiPrimaryOwner":{"type":"boolean"},"default":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"permissions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"scope":{"$ref":"#/components/schemas/RoleScope"},"system":{"type":"boolean"}}},"RoleMappingEntity":{"required":["environments","organizations"],"type":"object","properties":{"condition":{"type":"string"},"environments":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"organizations":{"type":"array","items":{"type":"string"}}}},"RoleMembership":{"type":"object","properties":{"id":{"type":"string"},"reference":{"type":"string"}}},"RoleScope":{"type":"string","enum":["API","APPLICATION","GROUP","ENVIRONMENT","ORGANIZATION","PLATFORM"]},"RoleScopesLinkedHashMap":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"RollbackApiEntity":{"required":["description","flows","id","name","paths","plans","proxy","version","visibility"],"type":"object","properties":{"background":{"type":"string","description":"the API background encoded in base64"},"background_url":{"type":"string","description":"the API background URL"},"categories":{"uniqueItems":true,"type":"array","description":"the list of categories associated with this API","example":"Product, Customer, Misc","items":{"type":"string","description":"the list of categories associated with this API","example":"Product, Customer, Misc"}},"description":{"type":"string","description":"API's description. A short description of your API.","example":"I can use a hundred characters to describe this API."},"disable_membership_notifications":{"type":"boolean"},"flow_mode":{"type":"string","description":"API's flow mode.","example":"BEST_MATCH","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","description":"a list of flows (the policies configuration)","items":{"$ref":"#/components/schemas/Flow"}},"gravitee":{"type":"string","description":"API's gravitee definition version"},"groups":{"uniqueItems":true,"type":"array","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"id":{"type":"string","description":"API's uuid.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"labels":{"type":"array","description":"the free list of labels associated with this API","example":"json, read_only, awesome","items":{"type":"string","description":"the free list of labels associated with this API","example":"json, read_only, awesome"}},"lifecycle_state":{"$ref":"#/components/schemas/ApiLifecycleState"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/ApiMetadataEntity"}},"name":{"type":"string","description":"Api's name. Duplicate names can exists.","example":"My Api"},"path_mappings":{"uniqueItems":true,"type":"array","description":"A list of paths used to aggregate data in analytics","example":"/products/:productId, /products/:productId/media","items":{"type":"string","description":"A list of paths used to aggregate data in analytics","example":"/products/:productId, /products/:productId/media"}},"paths":{"type":"object","additionalProperties":{"type":"array","description":"a map where you can associate a path to a configuration (the policies configuration)","items":{"$ref":"#/components/schemas/Rule"}},"description":"a map where you can associate a path to a configuration (the policies configuration)"},"picture":{"type":"string","description":"the API logo encoded in base64"},"picture_url":{"type":"string","description":"the API logo URL"},"plans":{"type":"array","description":"a list of plans with flows (the policies configuration)","items":{"$ref":"#/components/schemas/Plan"}},"properties":{"type":"array","description":"A dictionary (could be dynamic) of properties available in the API context.","items":{"$ref":"#/components/schemas/Property"}},"proxy":{"$ref":"#/components/schemas/Proxy"},"resources":{"type":"array","description":"The list of API resources used by policies like cache resources or oauth2","items":{"$ref":"#/components/schemas/Resource"}},"response_templates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ResponseTemplate"},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-ky is missing, ..."},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-ky is missing, ..."},"services":{"$ref":"#/components/schemas/Services"},"tags":{"uniqueItems":true,"type":"array","description":"the list of sharding tags associated with this API.","example":"public, private","items":{"type":"string","description":"the list of sharding tags associated with this API.","example":"public, private"}},"version":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"},"visibility":{"$ref":"#/components/schemas/Visibility"}}},"Rule":{"type":"object","properties":{"description":{"type":"string"},"enabled":{"type":"boolean"},"methods":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE","OTHER"]}}},"additionalProperties":{"type":"object"}},"SearchLogResponse":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/Log"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"total":{"type":"integer","format":"int64"}}},"SearchLogResponseApiRequestItem":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/ApiRequestItem"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"total":{"type":"integer","format":"int64"}}},"SearchLogResponseApplicationRequestItem":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRequestItem"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"total":{"type":"integer","format":"int64"}}},"SearchLogResponsePlatformRequestItem":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/PlatformRequestItem"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"total":{"type":"integer","format":"int64"}}},"SearchableUser":{"type":"object","properties":{"displayName":{"type":"string"},"email":{"type":"string"},"firstname":{"type":"string"},"id":{"type":"string"},"lastname":{"type":"string"},"picture":{"type":"string"},"reference":{"type":"string"}}},"Selector":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["HTTP","CHANNEL","CONDITION"]}},"discriminator":{"propertyName":"type"}},"ServiceV4":{"required":["type"],"type":"object","properties":{"configuration":{"type":"object"},"enabled":{"type":"boolean"},"type":{"type":"string"}}},"Services":{"type":"object","properties":{"discovery":{"$ref":"#/components/schemas/EndpointDiscoveryService"},"dynamic-property":{"$ref":"#/components/schemas/DynamicPropertyService"},"health-check":{"$ref":"#/components/schemas/HealthCheckService"}},"description":"The configuration of API services like the dynamic properties, the endpoint discovery or the healthcheck."},"SimpleApplicationSettings":{"type":"object","properties":{"client_id":{"type":"string"},"type":{"type":"string"}}},"SingleValueCondition":{"type":"object","properties":{"projections":{"type":"array","items":{"$ref":"#/components/schemas/Projection"}},"type":{"type":"string","enum":["STRING","THRESHOLD","THRESHOLD_RANGE","RATE","FREQUENCY","AGGREGATION","COMPARE","STRING_COMPARE","MISSING_DATA"]}}},"SocialIdentityProviderEntity":{"type":"object","properties":{"authorizationEndpoint":{"type":"string"},"clientId":{"type":"string"},"color":{"type":"string"},"description":{"type":"string"},"display":{"type":"string"},"emailRequired":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"optionalUrlParams":{"type":"array","items":{"type":"string"}},"requiredUrlParams":{"type":"array","items":{"type":"string"}},"scopeDelimiter":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"syncMappings":{"type":"boolean"},"tokenIntrospectionEndpoint":{"type":"string"},"type":{"$ref":"#/components/schemas/IdentityProviderType"},"userLogoutEndpoint":{"type":"string"}}},"Step":{"type":"object","properties":{"condition":{"type":"string"},"configuration":{"type":"object"},"description":{"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"policy":{"type":"string"}}},"StepV4":{"required":["description","name","policy"],"type":"object","properties":{"condition":{"type":"string"},"configuration":{"type":"object"},"description":{"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"policy":{"type":"string"}}},"StringCompareCondition":{"required":["operator","property","property2"],"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"property":{"type":"string"},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","STARTS_WITH","ENDS_WITH","CONTAINS","MATCHES"]},"property2":{"type":"string"},"ignoreCase":{"type":"boolean"}}}]},"StringCondition":{"required":["operator","pattern","property"],"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"property":{"type":"string"},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","STARTS_WITH","ENDS_WITH","CONTAINS","MATCHES"]},"pattern":{"type":"string"},"ignoreCase":{"type":"boolean"}}}]},"SubscribedApi":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"Subscription":{"type":"object","properties":{"api":{"$ref":"#/components/schemas/Api"},"application":{"$ref":"#/components/schemas/Application"},"client_id":{"type":"string"},"closed_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"ending_at":{"type":"string","format":"date-time"},"id":{"type":"string"},"paused_at":{"type":"string","format":"date-time"},"plan":{"$ref":"#/components/schemas/Plan"},"processed_at":{"type":"string","format":"date-time"},"processed_by":{"type":"string"},"reason":{"type":"string"},"request":{"type":"string"},"starting_at":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscribed_by":{"$ref":"#/components/schemas/User"},"updated_at":{"type":"string","format":"date-time"}}},"SubscriptionEntity":{"type":"object","properties":{"api":{"type":"string"},"application":{"type":"string"},"client_id":{"type":"string"},"closed_at":{"type":"string","format":"date-time"},"configuration":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"daysToExpirationOnLastNotification":{"type":"integer","format":"int32"},"ending_at":{"type":"string","format":"date-time"},"filter":{"type":"string"},"id":{"type":"string"},"keys":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"paused_at":{"type":"string","format":"date-time"},"plan":{"type":"string"},"processed_at":{"type":"string","format":"date-time"},"processed_by":{"type":"string"},"reason":{"type":"string"},"request":{"type":"string"},"security":{"type":"string"},"starting_at":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscribed_by":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"SubscriptionEntityPageResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionEntity"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object"}}},"page":{"$ref":"#/components/schemas/Page"}}},"SubscriptionListenerV4":{"required":["entrypoints","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ListenerV4"}]},"SubscriptionStatus":{"type":"string","enum":["PENDING","REJECTED","ACCEPTED","CLOSED","PAUSED","RESUMED"]},"TagEntity":{"required":["name"],"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"restricted_groups":{"type":"array","items":{"type":"string"}}}},"TaskEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"data":{"type":"object"},"type":{"$ref":"#/components/schemas/TaskType"}}},"TaskEntityPagedResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskEntity"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object"}}},"page":{"$ref":"#/components/schemas/Page"}}},"TaskType":{"type":"string","enum":["SUBSCRIPTION_APPROVAL","IN_REVIEW","REQUEST_FOR_CHANGES","USER_REGISTRATION_APPROVAL","PROMOTION_APPROVAL"]},"TcpListenerV4":{"required":["entrypoints","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ListenerV4"}]},"TenantEntity":{"required":["name"],"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"}}},"Theme":{"type":"object","properties":{"css":{"type":"string"},"loader":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"}}},"ThemeComponentDefinition":{"type":"object","properties":{"css":{"type":"array","items":{"$ref":"#/components/schemas/ThemeCssDefinition"}},"name":{"type":"string"}}},"ThemeCssDefinition":{"type":"object","properties":{"default":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ThemeCssType"},"value":{"type":"string"}}},"ThemeCssType":{"type":"string","enum":["color","length","string","image"]},"ThemeDefinition":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ThemeComponentDefinition"}}}},"ThemeEntity":{"required":["name"],"type":"object","properties":{"backgroundImage":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"definition":{"$ref":"#/components/schemas/ThemeDefinition"},"enabled":{"type":"boolean"},"favicon":{"type":"string"},"id":{"type":"string"},"logo":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"optionalLogo":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"ThresholdCondition":{"required":["operator","property","threshold"],"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"property":{"type":"string"},"operator":{"type":"string","enum":["LT","LTE","GTE","GT"]},"threshold":{"type":"number","format":"double"}}}]},"ThresholdRangeCondition":{"required":["operatorHigh","operatorLow","property","thresholdHigh","thresholdLow"],"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"property":{"type":"string"},"operatorLow":{"type":"string","enum":["INCLUSIVE","EXCLUSIVE"]},"thresholdLow":{"type":"number","format":"double"},"operatorHigh":{"type":"string","enum":["INCLUSIVE","EXCLUSIVE"]},"thresholdHigh":{"type":"number","format":"double"}}}]},"TicketEntity":{"type":"object","properties":{"api":{"type":"string"},"application":{"type":"string"},"content":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"from_user":{"type":"string"},"id":{"type":"string"},"subject":{"type":"string"}}},"TicketEntityPage":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/TicketEntity"}},"pageElements":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"TokenEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"id":{"type":"string"},"last_use_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"token":{"type":"string"}}},"TopApiEntity":{"type":"object","properties":{"api":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"picture_url":{"type":"string"},"version":{"type":"string"}}},"TransferOwnership":{"required":["role","type"],"type":"object","properties":{"id":{"type":"string","description":"User's technical identifier."},"reference":{"type":"string","description":"User's reference for user providing from an identity provider."},"role":{"type":"string","description":"Role's name"},"type":{"$ref":"#/components/schemas/MembershipMemberType"}}},"TransferSubscriptionEntity":{"required":["plan"],"type":"object","properties":{"id":{"type":"string"},"plan":{"type":"string"}}},"TrustStore":{"type":"object","properties":{"type":{"type":"string","enum":["PEM","PKCS12","JKS","None"]}},"discriminator":{"propertyName":"type","mapping":{"JKS":"#/components/schemas/JKSTrustStore","PEM":"#/components/schemas/PEMTrustStore","PKCS12":"#/components/schemas/PKCS12TrustStore"}}},"Type":{"type":"string","enum":["INLINE","URL"]},"UpdateAlertTriggerEntity":{"required":["name","severity"],"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}},"dampening":{"$ref":"#/components/schemas/Dampening"},"description":{"maxLength":256,"minLength":0,"type":"string"},"enabled":{"type":"boolean"},"event_rules":{"type":"array","items":{"$ref":"#/components/schemas/AlertEventRuleEntity"}},"filters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"name":{"type":"string"},"notificationPeriods":{"type":"array","items":{"$ref":"#/components/schemas/Period"}},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"reference_id":{"type":"string"},"reference_type":{"$ref":"#/components/schemas/AlertReferenceType"},"severity":{"type":"string","enum":["INFO","WARNING","CRITICAL"]},"source":{"type":"string"}}},"UpdateApiEntity":{"required":["description","name","proxy","version","visibility"],"type":"object","properties":{"background":{"type":"string","description":"the API background encoded in base64"},"background_url":{"type":"string","description":"the API background URL"},"categories":{"uniqueItems":true,"type":"array","description":"the list of categories associated with this API","example":"Product, Customer, Misc","items":{"type":"string","description":"the list of categories associated with this API","example":"Product, Customer, Misc"}},"crossId":{"type":"string","description":"API's crossId. Identifies API across environments.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"description":{"type":"string","description":"API's description. A short description of your API.","example":"I can use a hundred characters to describe this API."},"disable_membership_notifications":{"type":"boolean"},"execution_mode":{"type":"string","description":"Api's execution mode. Define if the execution mode should use v3 or jupiter mode.","example":"v3","enum":["V3","JUPITER"]},"flow_mode":{"type":"string","description":"API's flow mode.","example":"BEST_MATCH","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","description":"a list of flows (the policies configuration)","items":{"$ref":"#/components/schemas/Flow"}},"gravitee":{"type":"string","description":"API's gravitee definition version"},"groups":{"uniqueItems":true,"type":"array","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"labels":{"type":"array","description":"the free list of labels associated with this API","example":"json, read_only, awesome","items":{"type":"string","description":"the free list of labels associated with this API","example":"json, read_only, awesome"}},"lifecycle_state":{"$ref":"#/components/schemas/ApiLifecycleState"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/ApiMetadataEntity"}},"name":{"type":"string","description":"Api's name. Duplicate names can exists.","example":"My Api"},"path_mappings":{"uniqueItems":true,"type":"array","description":"A list of paths used to aggregate data in analytics","example":"/products/:productId, /products/:productId/media","items":{"type":"string","description":"A list of paths used to aggregate data in analytics","example":"/products/:productId, /products/:productId/media"}},"paths":{"type":"object","additionalProperties":{"type":"array","description":"a map where you can associate a path to a configuration (the policies configuration)","items":{"$ref":"#/components/schemas/Rule"}},"description":"a map where you can associate a path to a configuration (the policies configuration)"},"picture":{"type":"string","description":"the API logo encoded in base64"},"picture_url":{"type":"string","description":"the API logo URL"},"plans":{"uniqueItems":true,"type":"array","description":"a list of plans with flows (the policies configuration)","items":{"$ref":"#/components/schemas/PlanEntity"}},"properties":{"type":"array","description":"A dictionary (could be dynamic) of properties available in the API context.","items":{"$ref":"#/components/schemas/PropertyEntity"}},"proxy":{"$ref":"#/components/schemas/Proxy"},"resources":{"type":"array","description":"The list of API resources used by policies like cache resources or oauth2","items":{"$ref":"#/components/schemas/Resource"}},"response_templates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ResponseTemplate"},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-ky is missing, ..."},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-ky is missing, ..."},"services":{"$ref":"#/components/schemas/Services"},"tags":{"uniqueItems":true,"type":"array","description":"the list of sharding tags associated with this API.","example":"public, private","items":{"type":"string","description":"the list of sharding tags associated with this API.","example":"public, private"}},"version":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"},"visibility":{"$ref":"#/components/schemas/Visibility"}}},"UpdateApiEntityV4":{"required":["apiVersion","definitionVersion","description","endpointGroups","listeners","name","type","visibility"],"type":"object","properties":{"apiVersion":{"type":"string","description":"Api's version. It's a simple string only used in the portal.","example":"v1.0"},"background":{"type":"string","description":"the API background encoded in base64"},"backgroundUrl":{"type":"string","description":"the API background url.","example":"https://gravitee.mycompany.com/management/apis/6c530064-0b2c-4004-9300-640b2ce0047b/background"},"categories":{"uniqueItems":true,"type":"array","description":"the list of categories associated with this API","example":"Product, Customer, Misc","items":{"type":"string","description":"the list of categories associated with this API","example":"Product, Customer, Misc"}},"crossId":{"type":"string","description":"API's crossId. Identifies API across environments.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"definitionVersion":{"type":"string","description":"API's gravitee definition version","enum":["1.0.0","2.0.0","4.0.0"]},"description":{"type":"string","description":"API's description. A short description of your API.","example":"I can use a hundred characters to describe this API."},"disableMembershipNotifications":{"type":"boolean"},"endpointGroups":{"type":"array","description":"A list of endpoint describing the endpoints to contact.","items":{"$ref":"#/components/schemas/EndpointGroupV4"}},"flowMode":{"type":"string","description":"API's flow mode.","example":"BEST_MATCH","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","description":"A list of flows containing the policies configuration.","items":{"$ref":"#/components/schemas/FlowV4"}},"groups":{"uniqueItems":true,"type":"array","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"API's groups. Used to add team in your API.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"id":{"type":"string","description":"API's uuid.","example":"00f8c9e7-78fc-4907-b8c9-e778fc790750"},"labels":{"type":"array","description":"the free list of labels associated with this API","example":"json, read_only, awesome","items":{"type":"string","description":"the free list of labels associated with this API","example":"json, read_only, awesome"}},"lifecycleState":{"$ref":"#/components/schemas/ApiLifecycleState"},"listeners":{"type":"array","description":"A list of listeners used to describe our you api could be reached.","items":{"$ref":"#/components/schemas/ListenerV4"}},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/ApiMetadataEntity"}},"name":{"type":"string","description":"API's name. Duplicate names can exists.","example":"My Api"},"picture":{"type":"string","description":"the API logo encoded in base64"},"pictureUrl":{"type":"string","description":"the API logo URL.","example":"https://gravitee.mycompany.com/management/apis/6c530064-0b2c-4004-9300-640b2ce0047b/picture"},"plans":{"uniqueItems":true,"type":"array","description":"A list of plans to apply on the API","items":{"$ref":"#/components/schemas/PlanEntityV4"}},"properties":{"type":"array","description":"A dictionary (could be dynamic) of properties available in the API context.","items":{"$ref":"#/components/schemas/PropertyEntityV4"}},"resources":{"type":"array","description":"The list of API resources used by policies like cache resources or oauth2","items":{"$ref":"#/components/schemas/ResourceV4"}},"responseTemplates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ResponseTemplateV4"},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-key is missing, ..."},"description":"A map that allows you to configure the output of a request based on the event throws by the gateway. Example : Quota exceeded, api-key is missing, ..."},"services":{"$ref":"#/components/schemas/ApiServicesV4"},"tags":{"uniqueItems":true,"type":"array","description":"The list of sharding tags associated with this API.","example":"public, private","items":{"type":"string","description":"The list of sharding tags associated with this API.","example":"public, private"}},"type":{"type":"string","description":"API's type","example":"async","enum":["SYNC","ASYNC"]},"visibility":{"$ref":"#/components/schemas/Visibility"}}},"UpdateApiHeaderEntity":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"value":{"type":"string"}}},"UpdateApiMetadataEntity":{"required":["name"],"type":"object","properties":{"apiId":{"type":"string"},"defaultValue":{"type":"string"},"format":{"$ref":"#/components/schemas/MetadataFormat"},"hidden":{"type":"boolean"},"key":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"value":{"type":"string"}}},"UpdateApiQualityRuleEntity":{"type":"object","properties":{"api":{"type":"string"},"checked":{"type":"boolean"},"quality_rule":{"type":"string"}}},"UpdateApplicationEntity":{"required":["description","name","settings"],"type":"object","properties":{"api_key_mode":{"$ref":"#/components/schemas/ApiKeyMode"},"background":{"type":"string"},"clientId":{"type":"string"},"description":{"type":"string","description":"Application's description. A short description of your App.","example":"I can use a hundred characters to describe this App."},"disable_membership_notifications":{"type":"boolean"},"domain":{"type":"string","description":"Domain used by the application, if relevant","example":"https://my-app.com"},"groups":{"uniqueItems":true,"type":"array","description":"Application groups. Used to add teams to your application.","example":"['MY_GROUP1', 'MY_GROUP2']","items":{"type":"string","description":"Application groups. Used to add teams to your application.","example":"['MY_GROUP1', 'MY_GROUP2']"}},"name":{"type":"string","description":"Application's name. Duplicate names can exists.","example":"My App"},"picture":{"type":"string"},"picture_url":{"type":"string"},"settings":{"$ref":"#/components/schemas/ApplicationSettings"},"type":{"type":"string","description":"a string to describe the type of your app.","example":"iOS"}}},"UpdateApplicationMetadataEntity":{"required":["name"],"type":"object","properties":{"applicationId":{"type":"string"},"defaultValue":{"type":"string"},"format":{"$ref":"#/components/schemas/MetadataFormat"},"hidden":{"type":"boolean"},"key":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"value":{"type":"string"}}},"UpdateCategoryEntity":{"required":["name"],"type":"object","properties":{"background":{"type":"string"},"defaultCategory":{"type":"boolean"},"description":{"type":"string"},"hidden":{"type":"boolean"},"highlightApi":{"type":"string"},"id":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"order":{"type":"integer","format":"int32"},"page":{"type":"string"},"picture":{"type":"string"},"picture_url":{"type":"string"}}},"UpdateClientRegistrationProviderEntity":{"required":["discovery_endpoint","initial_access_token_type","name"],"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"description":{"type":"string"},"discovery_endpoint":{"type":"string"},"initial_access_token":{"type":"string"},"initial_access_token_type":{"$ref":"#/components/schemas/InitialAccessTokenType"},"name":{"type":"string"},"renew_client_secret_endpoint":{"type":"string"},"renew_client_secret_method":{"type":"string"},"renew_client_secret_support":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}},"software_id":{"type":"string"}}},"UpdateDashboardEntity":{"required":["name","order","reference_id","reference_type"],"type":"object","properties":{"definition":{"type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"name":{"maxLength":64,"minLength":0,"type":"string"},"order":{"type":"integer","format":"int32"},"query_filter":{"type":"string"},"reference_id":{"maxLength":64,"minLength":0,"type":"string"},"reference_type":{"$ref":"#/components/schemas/DashboardReferenceType"}}},"UpdateDictionaryEntity":{"required":["name","type"],"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}},"provider":{"$ref":"#/components/schemas/DictionaryProviderEntity"},"trigger":{"$ref":"#/components/schemas/DictionaryTriggerEntity"},"type":{"$ref":"#/components/schemas/DictionaryType"}}},"UpdateEntryPointEntity":{"required":["tags","value"],"type":"object","properties":{"id":{"type":"string"},"tags":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"type":"string"}},"value":{"maxLength":2147483647,"minLength":1,"type":"string"}}},"UpdateGroupEntity":{"required":["name"],"type":"object","properties":{"disable_membership_notifications":{"type":"boolean"},"email_invitation":{"type":"boolean"},"event_rules":{"type":"array","items":{"$ref":"#/components/schemas/GroupEventRuleEntity"}},"lock_api_role":{"type":"boolean"},"lock_application_role":{"type":"boolean"},"max_invitation":{"type":"integer","format":"int32"},"name":{"type":"string"},"roles":{"type":"object","additionalProperties":{"type":"string"}},"system_invitation":{"type":"boolean"}}},"UpdateIdentityProviderEntity":{"required":["configuration","enabled","name"],"type":"object","properties":{"configuration":{"type":"object","additionalProperties":{"type":"object"}},"description":{"type":"string"},"emailRequired":{"type":"boolean"},"enabled":{"type":"boolean"},"groupMappings":{"type":"array","items":{"$ref":"#/components/schemas/GroupMappingEntity"}},"name":{"type":"string"},"roleMappings":{"type":"array","items":{"$ref":"#/components/schemas/RoleMappingEntity"}},"syncMappings":{"type":"boolean"},"userProfileMapping":{"type":"object","additionalProperties":{"type":"string"}}}},"UpdateInvitationEntity":{"required":["email","reference_id","reference_type"],"type":"object","properties":{"api_role":{"type":"string"},"application_role":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"reference_id":{"type":"string"},"reference_type":{"$ref":"#/components/schemas/InvitationReferenceType"}}},"UpdateMetadataEntity":{"required":["name"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/MetadataFormat"},"hidden":{"type":"boolean"},"key":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"value":{"type":"string"}}},"UpdateOrganizationEntity":{"required":["name"],"type":"object","properties":{"cockpitId":{"type":"string"},"description":{"type":"string"},"domainRestrictions":{"type":"array","items":{"type":"string"}},"flowMode":{"type":"string","enum":["DEFAULT","BEST_MATCH"]},"flows":{"type":"array","items":{"$ref":"#/components/schemas/Flow"}},"hrids":{"type":"array","items":{"type":"string"}},"name":{"maxLength":2147483647,"minLength":1,"type":"string"}}},"UpdatePageEntity":{"type":"object","properties":{"accessControls":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AccessControlEntity"}},"attached_media":{"type":"array","items":{"$ref":"#/components/schemas/PageMediaEntity"}},"configuration":{"type":"object","additionalProperties":{"type":"string"}},"content":{"type":"string"},"crossId":{"type":"string"},"excludedAccessControls":{"type":"boolean"},"excluded_groups":{"type":"array","items":{"type":"string"}},"homepage":{"type":"boolean"},"lastContributor":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"parentId":{"type":"string"},"published":{"type":"boolean"},"source":{"$ref":"#/components/schemas/PageSourceEntity"},"useAutoFetch":{"type":"boolean"},"visibility":{"$ref":"#/components/schemas/Visibility"}}},"UpdatePlanEntity":{"required":["description","name","order","paths","validation"],"type":"object","properties":{"characteristics":{"type":"array","items":{"type":"string"}},"comment_message":{"type":"string"},"comment_required":{"type":"boolean"},"crossId":{"type":"string"},"description":{"type":"string"},"excluded_groups":{"type":"array","items":{"type":"string"}},"flows":{"type":"array","items":{"$ref":"#/components/schemas/Flow"}},"general_conditions":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"paths":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Rule"}}},"securityDefinition":{"type":"string"},"selection_rule":{"type":"string"},"tags":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"validation":{"$ref":"#/components/schemas/PlanValidationType"}}},"UpdatePlanEntityV4":{"required":["description","name","order","validation"],"type":"object","properties":{"characteristics":{"type":"array","items":{"type":"string"}},"commentMessage":{"type":"string"},"commentRequired":{"type":"boolean"},"crossId":{"type":"string"},"description":{"type":"string"},"excludedGroups":{"type":"array","items":{"type":"string"}},"flows":{"type":"array","items":{"$ref":"#/components/schemas/FlowV4"}},"generalConditions":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"security":{"$ref":"#/components/schemas/PlanSecurityV4"},"selectionRule":{"type":"string"},"tags":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"validation":{"$ref":"#/components/schemas/PlanValidationTypeV4"}}},"UpdateQualityRuleEntity":{"required":["description","name"],"type":"object","properties":{"description":{"maxLength":256,"minLength":0,"type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"name":{"maxLength":64,"minLength":0,"type":"string"},"weight":{"maximum":99999,"minimum":0,"type":"integer","format":"int32"}}},"UpdateRatingEntity":{"type":"object","properties":{"api":{"type":"string"},"comment":{"maxLength":1024,"minLength":0,"type":"string"},"id":{"type":"string"},"rate":{"type":"string","format":"byte"},"title":{"maxLength":64,"minLength":0,"type":"string"}}},"UpdateRoleEntity":{"required":["id","name","scope"],"type":"object","properties":{"default":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"permissions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"scope":{"$ref":"#/components/schemas/RoleScope"}}},"UpdateSubscriptionEntity":{"type":"object","properties":{"ending_at":{"type":"string","format":"date-time"},"id":{"type":"string"},"starting_at":{"type":"string","format":"date-time"}}},"UpdateTagEntity":{"required":["name"],"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"},"restricted_groups":{"type":"array","items":{"type":"string"}}}},"UpdateTenantEntity":{"required":["name"],"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"maxLength":2147483647,"minLength":1,"type":"string"}}},"UpdateThemeEntity":{"required":["definition","name"],"type":"object","properties":{"backgroundImage":{"type":"string"},"definition":{"$ref":"#/components/schemas/ThemeDefinition"},"enabled":{"type":"boolean"},"favicon":{"type":"string"},"id":{"type":"string"},"logo":{"type":"string"},"name":{"maxLength":64,"minLength":1,"type":"string"},"optionalLogo":{"type":"string"}}},"UpdateTopApiEntity":{"type":"object","properties":{"api":{"type":"string"},"order":{"type":"integer","format":"int32"}}},"UpdateUserEntity":{"type":"object","properties":{"customFields":{"type":"object","additionalProperties":{"type":"object"}},"email":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"newsletter":{"type":"boolean"},"picture":{"type":"string"},"status":{"type":"string"}}},"User":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"}}},"UserDetailRole":{"type":"object","properties":{"name":{"type":"string"},"permissions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"scope":{"type":"string"}}},"UserDetails":{"type":"object","properties":{"authorities":{"type":"array","items":{"$ref":"#/components/schemas/GrantedAuthority"}},"created_at":{"type":"string","format":"date-time"},"customFields":{"type":"object","additionalProperties":{"type":"object"}},"displayName":{"type":"string"},"displayNewsletterSubscription":{"type":"boolean"},"email":{"type":"string"},"enabled":{"type":"boolean"},"firstLogin":{"type":"boolean"},"firstname":{"type":"string"},"groupsByEnvironment":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"id":{"type":"string"},"last_connection_at":{"type":"string","format":"date-time"},"lastname":{"type":"string"},"picture":{"type":"array","items":{"type":"string","format":"byte"}},"primaryOwner":{"type":"boolean"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserDetailRole"}},"source":{"type":"string"},"sourceId":{"type":"string"},"system":{"type":"boolean"},"updated_at":{"type":"string","format":"date-time"}}},"UserEntity":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"customFields":{"type":"object","additionalProperties":{"type":"object"}},"displayName":{"type":"string","readOnly":true},"email":{"type":"string"},"envRoles":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/UserRoleEntity"}}},"firstConnectionAt":{"type":"string","format":"date-time"},"firstname":{"type":"string"},"id":{"type":"string"},"lastConnectionAt":{"type":"string","format":"date-time"},"lastname":{"type":"string"},"loginCount":{"type":"integer","format":"int64"},"newsletterSubscribed":{"type":"boolean"},"number_of_active_tokens":{"type":"integer","format":"int32"},"password":{"type":"string"},"picture":{"type":"string"},"primary_owner":{"type":"boolean"},"roles":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/UserRoleEntity"}},"source":{"type":"string"},"sourceId":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"UserGroupEntity":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"roles":{"type":"object","additionalProperties":{"type":"string"}}}},"UserMembership":{"type":"object","properties":{"reference":{"type":"string"},"roles":{"type":"object","additionalProperties":{"type":"string"}},"source":{"type":"string"},"type":{"type":"string"}}},"UserMembershipList":{"type":"object","properties":{"memberships":{"type":"array","items":{"$ref":"#/components/schemas/UserMembership"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object"}}}}},"UserPageResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserEntity"}},"metadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object"}}},"page":{"$ref":"#/components/schemas/Page"}}},"UserReferenceRoleEntity":{"type":"object","properties":{"referenceId":{"type":"string"},"referenceType":{"$ref":"#/components/schemas/MembershipReferenceType"},"roles":{"type":"array","items":{"type":"string"}},"user":{"type":"string"}}},"UserRoleEntity":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"permissions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"scope":{"$ref":"#/components/schemas/RoleScope"}}},"VerifyApiParam":{"required":["context_path"],"type":"object","properties":{"context_path":{"type":"string"}}},"VirtualHost":{"type":"object","properties":{"host":{"type":"string"},"override_entrypoint":{"type":"boolean"},"path":{"type":"string"}}},"Visibility":{"type":"string","description":"The visibility of the API regarding the portal.","example":"PUBLIC","enum":["PUBLIC","PRIVATE"]},"WorkflowState":{"type":"string","enum":["DRAFT","IN_REVIEW","REQUEST_FOR_CHANGES","REVIEW_OK"]}},"securitySchemes":{"gravitee-auth":{"type":"http","scheme":"basic"}}}}
/ auth / cockpit
/ organizations / {orgId}
/ organizations / {orgId} / audit
/ organizations / {orgId} / audit / events
/ organizations / {orgId} / auth / oauth2 / {identity}
/ organizations / {orgId} / auth / oauth2 / {identity} / exchange
/ organizations / {orgId} / configuration / custom-user-fields
/ organizations / {orgId} / configuration / custom-user-fields / {key}
/ organizations / {orgId} / configuration / entrypoints
/ organizations / {orgId} / configuration / entrypoints / {entrypoint}
/ organizations / {orgId} / configuration / flows
/ organizations / {orgId} / configuration / flows / configuration-schema
/ organizations / {orgId} / configuration / flows / flow-schema
/ organizations / {orgId} / configuration / identities
/ organizations / {orgId} / configuration / identities / {identityProvider}
/ organizations / {orgId} / configuration / notification-templates
/ organizations / {orgId} / configuration / notification-templates / {notificationTemplateId}
/ organizations / {orgId} / configuration / rolescopes
/ organizations / {orgId} / configuration / rolescopes / {scope} / roles
/ organizations / {orgId} / configuration / rolescopes / {scope} / roles / {role}
/ organizations / {orgId} / configuration / rolescopes / {scope} / roles / {role} / users
/ organizations / {orgId} / configuration / rolescopes / {scope} / roles / {role} / users / {userId}
/ organizations / {orgId} / configuration / tags
/ organizations / {orgId} / configuration / tags / {tag}
/ organizations / {orgId} / configuration / tenants
/ organizations / {orgId} / configuration / tenants / {tenant}
/ organizations / {orgId} / console
/ organizations / {orgId} / environments
/ organizations / {orgId} / environments / permissions
/ organizations / {orgId} / environments / {envId}
/ organizations / {orgId} / environments / {envId} / alerts / metrics
/ organizations / {orgId} / environments / {envId} / analytics
/ organizations / {orgId} / environments / {envId} / apis
/ organizations / {orgId} / environments / {envId} / apis / _paged
/ organizations / {orgId} / environments / {envId} / apis / _search
/ organizations / {orgId} / environments / {envId} / apis / _search / _paged
/ organizations / {orgId} / environments / {envId} / apis / hooks
/ organizations / {orgId} / environments / {envId} / apis / import
/ organizations / {orgId} / environments / {envId} / apis / import-url
/ organizations / {orgId} / environments / {envId} / apis / import / swagger
/ organizations / {orgId} / environments / {envId} / apis / schema
/ organizations / {orgId} / environments / {envId} / apis / verify
/ organizations / {orgId} / environments / {envId} / apis / {api}
/ organizations / {orgId} / environments / {envId} / apis / {api} / _debug
/ organizations / {orgId} / environments / {envId} / apis / {api} / _migrate
/ organizations / {orgId} / environments / {envId} / apis / {api} / _promote
/ organizations / {orgId} / environments / {envId} / apis / {api} / alerts
/ organizations / {orgId} / environments / {envId} / apis / {api} / alerts / analytics
/ organizations / {orgId} / environments / {envId} / apis / {api} / alerts / status
/ organizations / {orgId} / environments / {envId} / apis / {api} / alerts / {alert}
/ organizations / {orgId} / environments / {envId} / apis / {api} / alerts / {alert} / events
/ organizations / {orgId} / environments / {envId} / apis / {api} / analytics
/ organizations / {orgId} / environments / {envId} / apis / {api} / audit
/ organizations / {orgId} / environments / {envId} / apis / {api} / audit / events
/ organizations / {orgId} / environments / {envId} / apis / {api} / background
/ organizations / {orgId} / environments / {envId} / apis / {api} / definition
/ organizations / {orgId} / environments / {envId} / apis / {api} / deploy
/ organizations / {orgId} / environments / {envId} / apis / {api} / duplicate
/ organizations / {orgId} / environments / {envId} / apis / {api} / events
/ organizations / {orgId} / environments / {envId} / apis / {api} / events / search
/ organizations / {orgId} / environments / {envId} / apis / {api} / events / {eventId}
/ organizations / {orgId} / environments / {envId} / apis / {api} / export
/ organizations / {orgId} / environments / {envId} / apis / {api} / groups
/ organizations / {orgId} / environments / {envId} / apis / {api} / headers
/ organizations / {orgId} / environments / {envId} / apis / {api} / health
/ organizations / {orgId} / environments / {envId} / apis / {api} / health / average
/ organizations / {orgId} / environments / {envId} / apis / {api} / health / logs
/ organizations / {orgId} / environments / {envId} / apis / {api} / health / logs / {log}
/ organizations / {orgId} / environments / {envId} / apis / {api} / import
/ organizations / {orgId} / environments / {envId} / apis / {api} / import-path-mappings
/ organizations / {orgId} / environments / {envId} / apis / {api} / import-url
/ organizations / {orgId} / environments / {envId} / apis / {api} / import / swagger
/ organizations / {orgId} / environments / {envId} / apis / {api} / logs
/ organizations / {orgId} / environments / {envId} / apis / {api} / logs / export
/ organizations / {orgId} / environments / {envId} / apis / {api} / logs / {log}
/ organizations / {orgId} / environments / {envId} / apis / {api} / media / upload
/ organizations / {orgId} / environments / {envId} / apis / {api} / media / {hash}
/ organizations / {orgId} / environments / {envId} / apis / {api} / members
/ organizations / {orgId} / environments / {envId} / apis / {api} / members / permissions
/ organizations / {orgId} / environments / {envId} / apis / {api} / members / transfer_ownership
/ organizations / {orgId} / environments / {envId} / apis / {api} / messages
/ organizations / {orgId} / environments / {envId} / apis / {api} / metadata
/ organizations / {orgId} / environments / {envId} / apis / {api} / metadata / {metadata}
/ organizations / {orgId} / environments / {envId} / apis / {api} / notificationsettings
/ organizations / {orgId} / environments / {envId} / apis / {api} / notificationsettings / {notificationId}
/ organizations / {orgId} / environments / {envId} / apis / {api} / notifiers
/ organizations / {orgId} / environments / {envId} / apis / {api} / pages
/ organizations / {orgId} / environments / {envId} / apis / {api} / pages / _fetch
/ organizations / {orgId} / environments / {envId} / apis / {api} / pages / _import
/ organizations / {orgId} / environments / {envId} / apis / {api} / pages / {page}
/ organizations / {orgId} / environments / {envId} / apis / {api} / pages / {page} / _fetch
/ organizations / {orgId} / environments / {envId} / apis / {api} / pages / {page} / content
/ organizations / {orgId} / environments / {envId} / apis / {api} / pages / {page} / media
/ organizations / {orgId} / environments / {envId} / apis / {api} / picture
/ organizations / {orgId} / environments / {envId} / apis / {api} / plans
/ organizations / {orgId} / environments / {envId} / apis / {api} / plans / {plan}
/ organizations / {orgId} / environments / {envId} / apis / {api} / plans / {plan} / _close
/ organizations / {orgId} / environments / {envId} / apis / {api} / plans / {plan} / _deprecate
/ organizations / {orgId} / environments / {envId} / apis / {api} / plans / {plan} / _depreciate
/ organizations / {orgId} / environments / {envId} / apis / {api} / plans / {plan} / _publish
/ organizations / {orgId} / environments / {envId} / apis / {api} / quality
/ organizations / {orgId} / environments / {envId} / apis / {api} / quality-rules
/ organizations / {orgId} / environments / {envId} / apis / {api} / quality-rules / {qualityRule}
/ organizations / {orgId} / environments / {envId} / apis / {api} / ratings
/ organizations / {orgId} / environments / {envId} / apis / {api} / ratings / current
/ organizations / {orgId} / environments / {envId} / apis / {api} / ratings / summary
/ organizations / {orgId} / environments / {envId} / apis / {api} / ratings / {rating}
/ organizations / {orgId} / environments / {envId} / apis / {api} / ratings / {rating} / answers
/ organizations / {orgId} / environments / {envId} / apis / {api} / ratings / {rating} / answers / {answer}
/ organizations / {orgId} / environments / {envId} / apis / {api} / reviews
/ organizations / {orgId} / environments / {envId} / apis / {api} / rollback
/ organizations / {orgId} / environments / {envId} / apis / {api} / state
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscribers
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / _canCreate
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / export
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / {subscription}
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / {subscription} / _process
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / {subscription} / _transfer
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / {subscription} / apikeys
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / {subscription} / apikeys / _renew
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / {subscription} / apikeys / {apikey}
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / {subscription} / apikeys / {apikey} / _reactivate
/ organizations / {orgId} / environments / {envId} / apis / {api} / subscriptions / {subscription} / status
/ organizations / {orgId} / environments / {envId} / applications
/ organizations / {orgId} / environments / {envId} / applications / _paged
/ organizations / {orgId} / environments / {envId} / applications / hooks
/ organizations / {orgId} / environments / {envId} / applications / {application}
/ organizations / {orgId} / environments / {envId} / applications / {application} / _restore
/ organizations / {orgId} / environments / {envId} / applications / {application} / alerts
/ organizations / {orgId} / environments / {envId} / applications / {application} / alerts / status
/ organizations / {orgId} / environments / {envId} / applications / {application} / alerts / {alert}
/ organizations / {orgId} / environments / {envId} / applications / {application} / analytics
/ organizations / {orgId} / environments / {envId} / applications / {application} / apikeys
/ organizations / {orgId} / environments / {envId} / applications / {application} / apikeys / _renew
/ organizations / {orgId} / environments / {envId} / applications / {application} / apikeys / {apikey}
/ organizations / {orgId} / environments / {envId} / applications / {application} / background
/ organizations / {orgId} / environments / {envId} / applications / {application} / configuration
/ organizations / {orgId} / environments / {envId} / applications / {application} / logs
/ organizations / {orgId} / environments / {envId} / applications / {application} / logs / export
/ organizations / {orgId} / environments / {envId} / applications / {application} / logs / {log}
/ organizations / {orgId} / environments / {envId} / applications / {application} / members
/ organizations / {orgId} / environments / {envId} / applications / {application} / members / permissions
/ organizations / {orgId} / environments / {envId} / applications / {application} / members / transfer_ownership
/ organizations / {orgId} / environments / {envId} / applications / {application} / metadata
/ organizations / {orgId} / environments / {envId} / applications / {application} / metadata / {metadata}
/ organizations / {orgId} / environments / {envId} / applications / {application} / notificationsettings
/ organizations / {orgId} / environments / {envId} / applications / {application} / notificationsettings / {notificationId}
/ organizations / {orgId} / environments / {envId} / applications / {application} / notifiers
/ organizations / {orgId} / environments / {envId} / applications / {application} / picture
/ organizations / {orgId} / environments / {envId} / applications / {application} / renew_secret
/ organizations / {orgId} / environments / {envId} / applications / {application} / subscribed
/ organizations / {orgId} / environments / {envId} / applications / {application} / subscriptions
/ organizations / {orgId} / environments / {envId} / applications / {application} / subscriptions / {subscription}
/ organizations / {orgId} / environments / {envId} / applications / {application} / subscriptions / {subscription} / apikeys
/ organizations / {orgId} / environments / {envId} / applications / {application} / subscriptions / {subscription} / apikeys / _renew
/ organizations / {orgId} / environments / {envId} / applications / {application} / subscriptions / {subscription} / apikeys / {apikey}
/ organizations / {orgId} / environments / {envId} / audit
/ organizations / {orgId} / environments / {envId} / audit / events
/ organizations / {orgId} / environments / {envId} / auth / oauth2 / {identity}
/ organizations / {orgId} / environments / {envId} / auth / oauth2 / {identity} / exchange
/ organizations / {orgId} / environments / {envId} / configuration / apiheaders
/ organizations / {orgId} / environments / {envId} / configuration / apiheaders / {id}
/ organizations / {orgId} / environments / {envId} / configuration / applications / registration / providers
/ organizations / {orgId} / environments / {envId} / configuration / applications / registration / providers / {clientRegistrationProvider}
/ organizations / {orgId} / environments / {envId} / configuration / applications / types
/ organizations / {orgId} / environments / {envId} / configuration / categories
/ organizations / {orgId} / environments / {envId} / configuration / categories / {categoryId}
/ organizations / {orgId} / environments / {envId} / configuration / categories / {categoryId} / background
/ organizations / {orgId} / environments / {envId} / configuration / categories / {categoryId} / picture
/ organizations / {orgId} / environments / {envId} / configuration / dashboards
/ organizations / {orgId} / environments / {envId} / configuration / dashboards / {dashboardId}
/ organizations / {orgId} / environments / {envId} / configuration / dictionaries
/ organizations / {orgId} / environments / {envId} / configuration / dictionaries / {dictionary}
/ organizations / {orgId} / environments / {envId} / configuration / dictionaries / {dictionary} / _deploy
/ organizations / {orgId} / environments / {envId} / configuration / dictionaries / {dictionary} / _undeploy
/ organizations / {orgId} / environments / {envId} / configuration / entrypoints
/ organizations / {orgId} / environments / {envId} / configuration / entrypoints / {entrypoint}
/ organizations / {orgId} / environments / {envId} / configuration / groups
/ organizations / {orgId} / environments / {envId} / configuration / groups / {group}
/ organizations / {orgId} / environments / {envId} / configuration / groups / {group} / invitations
/ organizations / {orgId} / environments / {envId} / configuration / groups / {group} / invitations / {invitation}
/ organizations / {orgId} / environments / {envId} / configuration / groups / {group} / members
/ organizations / {orgId} / environments / {envId} / configuration / groups / {group} / members / _paged
/ organizations / {orgId} / environments / {envId} / configuration / groups / {group} / members / {member}
/ organizations / {orgId} / environments / {envId} / configuration / groups / {group} / memberships
/ organizations / {orgId} / environments / {envId} / configuration / hooks
/ organizations / {orgId} / environments / {envId} / configuration / identities
/ organizations / {orgId} / environments / {envId} / configuration / identities / {identityProvider}
/ organizations / {orgId} / environments / {envId} / configuration / metadata
/ organizations / {orgId} / environments / {envId} / configuration / metadata / {metadata}
/ organizations / {orgId} / environments / {envId} / configuration / notificationsettings
/ organizations / {orgId} / environments / {envId} / configuration / notificationsettings / {notificationId}
/ organizations / {orgId} / environments / {envId} / configuration / notifiers
/ organizations / {orgId} / environments / {envId} / configuration / plans
/ organizations / {orgId} / environments / {envId} / configuration / quality-rules
/ organizations / {orgId} / environments / {envId} / configuration / quality-rules / {id}
/ organizations / {orgId} / environments / {envId} / configuration / rolescopes
/ organizations / {orgId} / environments / {envId} / configuration / rolescopes / {scope} / roles
/ organizations / {orgId} / environments / {envId} / configuration / rolescopes / {scope} / roles / {role}
/ organizations / {orgId} / environments / {envId} / configuration / rolescopes / {scope} / roles / {role} / users
/ organizations / {orgId} / environments / {envId} / configuration / rolescopes / {scope} / roles / {role} / users / {userId}
/ organizations / {orgId} / environments / {envId} / configuration / spel / grammar
/ organizations / {orgId} / environments / {envId} / configuration / tags
/ organizations / {orgId} / environments / {envId} / configuration / tags / {tag}
/ organizations / {orgId} / environments / {envId} / configuration / tenants
/ organizations / {orgId} / environments / {envId} / configuration / tenants / {tenant}
/ organizations / {orgId} / environments / {envId} / configuration / themes
/ organizations / {orgId} / environments / {envId} / configuration / themes / {themeId}
/ organizations / {orgId} / environments / {envId} / configuration / themes / {themeId} / backgroundImage
/ organizations / {orgId} / environments / {envId} / configuration / themes / {themeId} / favicon
/ organizations / {orgId} / environments / {envId} / configuration / themes / {themeId} / logo
/ organizations / {orgId} / environments / {envId} / configuration / themes / {themeId} / optionalLogo
/ organizations / {orgId} / environments / {envId} / configuration / themes / {themeId} / reset
/ organizations / {orgId} / environments / {envId} / configuration / top-apis
/ organizations / {orgId} / environments / {envId} / configuration / top-apis / {topAPI}
/ organizations / {orgId} / environments / {envId} / connectors
/ organizations / {orgId} / environments / {envId} / connectors / {connector}
/ organizations / {orgId} / environments / {envId} / connectors / {connector} / documentation
/ organizations / {orgId} / environments / {envId} / connectors / {connector} / schema
/ organizations / {orgId} / environments / {envId} / entrypoints
/ organizations / {orgId} / environments / {envId} / fetchers
/ organizations / {orgId} / environments / {envId} / fetchers / {fetcher}
/ organizations / {orgId} / environments / {envId} / fetchers / {fetcher} / schema
/ organizations / {orgId} / environments / {envId} / identities
/ organizations / {orgId} / environments / {envId} / instances
/ organizations / {orgId} / environments / {envId} / instances / {instance}
/ organizations / {orgId} / environments / {envId} / instances / {instance} / monitoring / {gatewayId}
/ organizations / {orgId} / environments / {envId} / messages
/ organizations / {orgId} / environments / {envId} / notifiers
/ organizations / {orgId} / environments / {envId} / notifiers / {notifier}
/ organizations / {orgId} / environments / {envId} / notifiers / {notifier} / schema
/ organizations / {orgId} / environments / {envId} / permissions
/ organizations / {orgId} / environments / {envId} / platform / alerts
/ organizations / {orgId} / environments / {envId} / platform / alerts / analytics
/ organizations / {orgId} / environments / {envId} / platform / alerts / status
/ organizations / {orgId} / environments / {envId} / platform / alerts / {alert}
/ organizations / {orgId} / environments / {envId} / platform / alerts / {alert} / events
/ organizations / {orgId} / environments / {envId} / platform / analytics
/ organizations / {orgId} / environments / {envId} / platform / events
/ organizations / {orgId} / environments / {envId} / platform / logs
/ organizations / {orgId} / environments / {envId} / platform / logs / export
/ organizations / {orgId} / environments / {envId} / platform / logs / {log}
/ organizations / {orgId} / environments / {envId} / platform / tickets
/ organizations / {orgId} / environments / {envId} / platform / tickets / {ticket}
/ organizations / {orgId} / environments / {envId} / policies
/ organizations / {orgId} / environments / {envId} / policies / swagger
/ organizations / {orgId} / environments / {envId} / policies / {policy}
/ organizations / {orgId} / environments / {envId} / policies / {policy} / documentation
/ organizations / {orgId} / environments / {envId} / policies / {policy} / icon
/ organizations / {orgId} / environments / {envId} / policies / {policy} / schema
/ organizations / {orgId} / environments / {envId} / portal
/ organizations / {orgId} / environments / {envId} / portal / apis / _search
/ organizations / {orgId} / environments / {envId} / portal / identities
/ organizations / {orgId} / environments / {envId} / portal / media / upload
/ organizations / {orgId} / environments / {envId} / portal / media / {hash}
/ organizations / {orgId} / environments / {envId} / portal / pages
/ organizations / {orgId} / environments / {envId} / portal / pages / _fetch
/ organizations / {orgId} / environments / {envId} / portal / pages / _import
/ organizations / {orgId} / environments / {envId} / portal / pages / {page}
/ organizations / {orgId} / environments / {envId} / portal / pages / {page} / _fetch
/ organizations / {orgId} / environments / {envId} / portal / pages / {page} / content
/ organizations / {orgId} / environments / {envId} / portal / pages / {page} / media
/ organizations / {orgId} / environments / {envId} / promotion-targets
/ organizations / {orgId} / environments / {envId} / resources
/ organizations / {orgId} / environments / {envId} / resources / {resource}
/ organizations / {orgId} / environments / {envId} / resources / {resource} / documentation
/ organizations / {orgId} / environments / {envId} / resources / {resource} / schema
/ organizations / {orgId} / environments / {envId} / search / users
/ organizations / {orgId} / environments / {envId} / services-discovery
/ organizations / {orgId} / environments / {envId} / services-discovery / {plugin}
/ organizations / {orgId} / environments / {envId} / services-discovery / {plugin} / schema
/ organizations / {orgId} / environments / {envId} / settings
/ organizations / {orgId} / environments / {envId} / subscriptions
/ organizations / {orgId} / environments / {envId} / tickets
/ organizations / {orgId} / environments / {envId} / tickets / {ticket}
/ organizations / {orgId} / environments / {envId} / user
/ organizations / {orgId} / environments / {envId} / user / avatar
/ organizations / {orgId} / environments / {envId} / user / login
/ organizations / {orgId} / environments / {envId} / user / logout
/ organizations / {orgId} / environments / {envId} / user / newsletter / _subscribe
/ organizations / {orgId} / environments / {envId} / user / newsletter / taglines
/ organizations / {orgId} / environments / {envId} / user / notifications
/ organizations / {orgId} / environments / {envId} / user / notifications / {notification}
/ organizations / {orgId} / environments / {envId} / user / tags
/ organizations / {orgId} / environments / {envId} / user / tasks
/ organizations / {orgId} / environments / {envId} / user / tokens
/ organizations / {orgId} / environments / {envId} / user / tokens / {token}
/ organizations / {orgId} / environments / {envId} / users
/ organizations / {orgId} / environments / {envId} / users / registration
/ organizations / {orgId} / environments / {envId} / users / registration / finalize
/ organizations / {orgId} / environments / {envId} / users / {userId}
/ organizations / {orgId} / environments / {envId} / users / {userId} / _process
/ organizations / {orgId} / environments / {envId} / users / {userId} / avatar
/ organizations / {orgId} / environments / {envId} / users / {userId} / changePassword
/ organizations / {orgId} / environments / {envId} / users / {userId} / groups
/ organizations / {orgId} / environments / {envId} / users / {userId} / memberships
/ organizations / {orgId} / environments / {envId} / users / {userId} / resetPassword
/ organizations / {orgId} / environments / {envId} / users / {userId} / roles
/ organizations / {orgId} / environments / {envId} / users / {userId} / tokens
/ organizations / {orgId} / environments / {envId} / users / {userId} / tokens / {token}
/ organizations / {orgId} / environments / {envId} / v4 / apis
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api}
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / deploy
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / events
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / events / search
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / events / {eventId}
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / groups
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / members
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / members / permissions
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / members / transfer_ownership
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / metadata
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / metadata / {metadata}
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / pages
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / pages / _fetch
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / pages / _import
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / pages / {page}
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / pages / {page} / _fetch
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / pages / {page} / content
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / pages / {page} / media
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / plans
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / plans / {plan}
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / plans / {plan} / _close
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / plans / {plan} / _deprecate
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / plans / {plan} / _depreciate
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / plans / {plan} / _publish
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / ratings
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / ratings / current
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / ratings / summary
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / ratings / {rating}
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / ratings / {rating} / answers
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / ratings / {rating} / answers / {answer}
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscribers
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / _canCreate
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / export
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / {subscription}
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / {subscription} / _process
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / {subscription} / _transfer
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / {subscription} / apikeys
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / {subscription} / apikeys / _renew
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / {subscription} / apikeys / {apikey}
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / {subscription} / apikeys / {apikey} / _reactivate
/ organizations / {orgId} / environments / {envId} / v4 / apis / {api} / subscriptions / {subscription} / status
/ organizations / {orgId} / environments / {envId} / v4 / entrypoints
/ organizations / {orgId} / environments / {envId} / v4 / entrypoints / {entrypoint}
/ organizations / {orgId} / environments / {envId} / v4 / entrypoints / {entrypoint} / documentation
/ organizations / {orgId} / environments / {envId} / v4 / entrypoints / {entrypoint} / schema
/ organizations / {orgId} / groups
/ organizations / {orgId} / identities
/ organizations / {orgId} / promotions / _search
/ organizations / {orgId} / promotions / {promotion} / _process
/ organizations / {orgId} / search / users
/ organizations / {orgId} / settings
/ organizations / {orgId} / social-identities
/ organizations / {orgId} / user
/ organizations / {orgId} / user / avatar
/ organizations / {orgId} / user / login
/ organizations / {orgId} / user / logout
/ organizations / {orgId} / user / newsletter / _subscribe
/ organizations / {orgId} / user / newsletter / taglines
/ organizations / {orgId} / user / notifications
/ organizations / {orgId} / user / notifications / {notification}
/ organizations / {orgId} / user / tags
/ organizations / {orgId} / user / tasks
/ organizations / {orgId} / user / tokens
/ organizations / {orgId} / user / tokens / {token}
/ organizations / {orgId} / users
/ organizations / {orgId} / users / registration
/ organizations / {orgId} / users / registration / finalize
/ organizations / {orgId} / users / {userId}
/ organizations / {orgId} / users / {userId} / _process
/ organizations / {orgId} / users / {userId} / avatar
/ organizations / {orgId} / users / {userId} / changePassword
/ organizations / {orgId} / users / {userId} / groups
/ organizations / {orgId} / users / {userId} / memberships
/ organizations / {orgId} / users / {userId} / resetPassword
/ organizations / {orgId} / users / {userId} / roles
/ organizations / {orgId} / users / {userId} / tokens
/ organizations / {orgId} / users / {userId} / tokens / {token}
No API Resources

(Product) (Docs)

{"class":["gateway"],"properties":{"name":"KrakenD","provider":"KrakenD","slug":"krakend","rating":2,"license":"Apache/2.0, Proprietary","status":"Pending Review","researchDate":"2021-10","description":"KrakenD offers two different editions, KrakenD CE (Community Edition)  and KrakenD EE (Enteprise Edition).  The Gateway engine of KrakenD,  an open source project, has joined the Linux Foundation as [Lura](https://github.com/luraproject/lura). KrakenD touts that it's built for performance.  This Gateway is often deployed as a backend-for-frontend or a façade aggregator on top of many different microservices. KrakenD is primarily used as a stateless component in user infrastructure.  There's no data store dependency required for most operations, which may simplify deployment and management. Message transformation can be configured using the [Martian DSL](https://github.com/google/martian) while message validation can benefit from Google's [Common Expression Language CEL)](https://github.com/google/cel-spec). KrakenD has a JSON-based file configuration with a Web-based editor in KrakenD Designer (CE) or KrakenD Studio (EE). Enterprise features include commercial support, KrakenD studio, and enterprise plugins.\n","platformCapabilities":["Gateway","Monitoring","Documentation","Threat Protection","Analytics"],"gatewayCapabilities":["Custom Code Execution","Mediation","Traffic Management","OpenAPI Integration","Protocol Transformation"],"customCodeSupport":["Go","Lua","Martian DSL"],"upstreamProtocols":["HTTP/1.1","HTTP/2","gRPC","WebSockets","SOAP","AWS Lambda"],"downstreamProtocols":["HTTP/1.1","HTTP/2","gRPC","AMQP"],"deliveryModels":["SaaS","Customer Managed (Cloud)","Customer Managed (On-Premises)","Hybrid"],"policies":[{"category":"Security","capabilities":["OAuth 2.0","JWT","Basic Authentication","API Key Authentication","Mutual TLS","Bot Detector","XSS Protection","CORS"]},{"category":"Traffic Management","capabilities":["Circuit Breaker","Spike Arrest","Rate Limiting","Service Discovery","Concurrent Rate Limiting"]},{"category":"Mediation","capabilities":["Cache Lookup","Cache Store","Cache Eviction","Request Transformation","Response Transformation"]},{"category":"Extensions","capabilities":["Auth0 Integration","Keycloak Integration","Message Logging","Lua Scripting","Go Extensions"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://www.krakend.io"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://www.krakend.io/docs/overview/introduction/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/krakend.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/krakend.png"}]}

KrakenD

KrakenD offers two different editions, KrakenD CE (Community Edition) and KrakenD EE (Enteprise Edition). The Gateway engine of KrakenD, an open source project, has joined the Linux Foundation as [Lura](https://github.com/luraproject/lura). KrakenD touts that it's built for performance. This Gateway is often deployed as a backend-for-frontend or a façade aggregator on top of many different microservices. KrakenD is primarily used as a stateless component in user infrastructure. There's no data store dependency required for most operations, which may simplify deployment and management. Message transformation can be configured using the [Martian DSL](https://github.com/google/martian) while message validation can benefit from Google's [Common Expression Language CEL)](https://github.com/google/cel-spec). KrakenD has a JSON-based file configuration with a Web-based editor in KrakenD Designer (CE) or KrakenD Studio (EE). Enterprise features include commercial support, KrakenD studio, and enterprise plugins.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Gateway
Monitoring
Documentation
Threat Protection
Analytics

Gateway Capabilities

These are the capabilities the gateway supports.

Custom Code Execution
Mediation
Traffic Management
OpenAPI Integration
Protocol Transformation

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1
HTTP/2
gRPC
WebSockets
SOAP
AWS Lambda

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1
HTTP/2
gRPC
AMQP

Custom Code

If they offer plugin, extension, and custom coding options.

Go
Lua
Martian DSL

Delivery Models

These are they ways you can deliver this solution.

SaaS
Customer Managed (Cloud)
Customer Managed (On-Premises)
Hybrid

Policies

These are the policies available across the gateway capabilities.

Security

OAuth 2.0
JWT
Basic Authentication
API Key Authentication
Mutual TLS
Bot Detector
XSS Protection
CORS

Traffic Management

Circuit Breaker
Spike Arrest
Rate Limiting
Service Discovery
Concurrent Rate Limiting

Mediation

Cache Lookup
Cache Store
Cache Eviction
Request Transformation
Response Transformation

Extensions

Auth0 Integration
Keycloak Integration
Message Logging
Lua Scripting
Go Extensions

API Resources

No API Resources

(Product) (Docs)

{"class":["gateway"],"properties":{"name":"Kusk","provider":"Kusk","slug":"kusk","rating":2,"license":"Proprietary, Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2021-10","description":"Develop, validate, deploy and monitor your APIs in a matter of minutes. The one-stop shop for building modern REST APIs based on Envoy Proxy running on your Kubernetes cluster.\n","platformCapabilities":["Design","Gateway","Analytics","Testing"],"gatewayCapabilities":["Mediation","Mocking","OpenAPI Integration","Traffic Management","Versioning"],"customCodeSupport":["None"],"upstreamProtocols":["HTTP/1.1"],"downstreamProtocols":["HTTP/1.1"],"deliveryModels":["SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Caching","Quota","Quota Reset","Rate Limiting","Request Size Limiting","Service Discovery","Throttling","Traffic Optimization"]},{"category":"Mediation","capabilities":["CORS","Request Size Limit","Request Termination","Request Validation","Request Transformation","Response Transformation"]},{"category":"Security","capabilities":["API Key","API Key Authentication","Access Control Lists (ACL)","Audit Logs","Basic Authentication","CORS","IP Access Rules","JWT","JWT Validation","JWT authorizers","JWT authorizers (Custom","Mutual TLS","OAuth 1.0","OAuth 2.0"]},{"category":"Extensions","capabilities":["Kubernetes","Envoy Proxy","Command Line Interface (CLI)"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://kusk.io/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://kusk.io/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/name.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/kusk.png"}]}

Kusk

Develop, validate, deploy and monitor your APIs in a matter of minutes. The one-stop shop for building modern REST APIs based on Envoy Proxy running on your Kubernetes cluster.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Design
Gateway
Analytics
Testing

Gateway Capabilities

These are the capabilities the gateway supports.

Mediation
Mocking
OpenAPI Integration
Traffic Management
Versioning

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1

Custom Code

If they offer plugin, extension, and custom coding options.

None

Delivery Models

These are they ways you can deliver this solution.

SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

Caching
Quota
Quota Reset
Rate Limiting
Request Size Limiting
Service Discovery
Throttling
Traffic Optimization

Mediation

CORS
Request Size Limit
Request Termination
Request Validation
Request Transformation
Response Transformation

Security

API Key
API Key Authentication
Access Control Lists (ACL)
Audit Logs
Basic Authentication
CORS
IP Access Rules
JWT
JWT Validation
JWT authorizers
JWT authorizers (Custom
Mutual TLS
OAuth 1.0
OAuth 2.0

Extensions

Kubernetes
Envoy Proxy
Command Line Interface (CLI)

API Resources

No API Resources

(Product) (Docs)

{"class":["gateway"],"properties":{"name":"Reactive Interaction Gateway","provider":"Reactive Interaction Gateway","slug":"reactive-interaction-gateway","rating":2,"license":"Proprietary, Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2022-11","description":"The REactive Interaction Gatewy is focused on optimizing microservice operations, decoupling the services using some kind of messaging service, like Kafka; now the backend-for-frontends service simply listens to the Kafka stream, where all other services publish their events to. Providing a gateway that subscribes to Kafka topics, while holding connections to all active frontends, forwarding events to the users they're addressed to, all in a scalable way. And on top of that, it also handles authorization, so your services don't have to care about that either.\n","platformCapabilities":["Gateway","Analytics"],"gatewayCapabilities":["Mediation","OpenAPI Integration","Protocol Transformation","Traffic Management","Versioning"],"customCodeSupport":["None"],"upstreamProtocols":["HTTP/1.1","Kafka","WebSockets","Server-Sent Events (SSE)","HTTP long-polling","NATS"],"downstreamProtocols":["HTTP/1.1","Kafka","WebSockets","Server-Sent Events (SSE)","HTTP long-polling","NATS"],"deliveryModels":["Customer Managed (On-Premises)"],"policies":[{"category":"Traffic Management","capabilities":["Quota","Quota Reset","Rate Limiting","Request Size Limiting","Throttling","Traffic Optimization","Tracing"]},{"category":"Mediation","capabilities":["CORS","Request Size Limit","Request Termination","Request Transformation","Response Transformation","URL Rewriting"]},{"category":"Security","capabilities":["API Key","API Key Authentication","Access Control Lists","Audit Logs","Basic Authentication","CORS","JWT","JWT Validation","JWT authorizers","IP Access Rules","Mutual TLS","OAuth 1.0","OAuth 2.0"]},{"category":"Extensions","capabilities":["HTTP Callout","HTTP integrations","Avro","Azure Event Hubs","AWS Kinesis"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://accenture.github.io/reactive-interaction-gateway/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://github.com/Accenture/reactive-interaction-gateway"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/name.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/reactive-interaction-gateway.png"}]}

Reactive Interaction Gateway

The REactive Interaction Gatewy is focused on optimizing microservice operations, decoupling the services using some kind of messaging service, like Kafka; now the backend-for-frontends service simply listens to the Kafka stream, where all other services publish their events to. Providing a gateway that subscribes to Kafka topics, while holding connections to all active frontends, forwarding events to the users they're addressed to, all in a scalable way. And on top of that, it also handles authorization, so your services don't have to care about that either.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Gateway
Analytics

Gateway Capabilities

These are the capabilities the gateway supports.

Mediation
OpenAPI Integration
Protocol Transformation
Traffic Management
Versioning

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1
Kafka
WebSockets
Server-Sent Events (SSE)
HTTP long-polling
NATS

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1
Kafka
WebSockets
Server-Sent Events (SSE)
HTTP long-polling
NATS

Custom Code

If they offer plugin, extension, and custom coding options.

None

Delivery Models

These are they ways you can deliver this solution.

Customer Managed (On-Premises)

Policies

These are the policies available across the gateway capabilities.

Traffic Management

Quota
Quota Reset
Rate Limiting
Request Size Limiting
Throttling
Traffic Optimization
Tracing

Mediation

CORS
Request Size Limit
Request Termination
Request Transformation
Response Transformation
URL Rewriting

Security

API Key
API Key Authentication
Access Control Lists
Audit Logs
Basic Authentication
CORS
JWT
JWT Validation
JWT authorizers
IP Access Rules
Mutual TLS
OAuth 1.0
OAuth 2.0

Extensions

HTTP Callout
HTTP integrations
Avro
Azure Event Hubs
AWS Kinesis

API Resources

No API Resources

(Product) (Docs)

{"class":["gateway"],"properties":{"name":"Solo","provider":"Solo","slug":"solo","rating":2,"license":"Proprietary, Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2022-11","description":"Architecturally, API gateways have both a data plane and a control plane. The data plane is where traffic flows from your external clients through the proxies to the backend services. The control plane is where your configuration and policies are defined. These configurations are pushed to the proxies to adjust the flow of traffic or to add security checks like authentication. With adoption of Kubernetes containers and cloud-native architectures for modern applications, technologies like the open source Envoy Proxy and Istio have emerged to enable application networking for distributed systems. Envoy has become the most popular proxy at the edge, and also as the sidecar to handle internal traffic in an Istio service mesh.\n","platformCapabilities":["Design","Gateway","Analytics","Documentation","Observability"],"gatewayCapabilities":["Mediation","Traffic Management"],"customCodeSupport":["WASM"],"upstreamProtocols":["HTTP/1.1"],"downstreamProtocols":["HTTP/1.1"],"deliveryModels":["SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Circuit Breaker","Conditional Routing","Content-Based Routing","Dynamic Routing","Failover","Ingress Controller","Egress Controller","Load Balancer Routing","Quota","Quota Reset","Rate Limiting","Request Size Limiting","Service Discovery","Throttling","Traffic Optimization"]},{"category":"Mediation","capabilities":["CORS","Custom Resources","Request Size Limit","Request Termination","Request Transformation","Response Transformation","URL Rewriting"]},{"category":"Security","capabilities":["API Key","API Key Authentication","Access Control Lists (ACL)","Audit Logs","Basic Authentication","CORS","IP Access Rules","JWT Validation","JWT authorizers","Message Inspection","Mutual TLS","OAuth 1.0","OAuth 2.0"]},{"category":"Extensions","capabilities":["AWS Integrations","HTTP Callout","HTTP integrations","Kubernetes","Contains","Azure","Google Cloud","Serverless","Open Policy Agent","Service Mesh"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://www.solo.io"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://www.solo.io/overview/kubernetes-api-gateway/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/solo.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/solo.png"}]}

Solo

Architecturally, API gateways have both a data plane and a control plane. The data plane is where traffic flows from your external clients through the proxies to the backend services. The control plane is where your configuration and policies are defined. These configurations are pushed to the proxies to adjust the flow of traffic or to add security checks like authentication. With adoption of Kubernetes containers and cloud-native architectures for modern applications, technologies like the open source Envoy Proxy and Istio have emerged to enable application networking for distributed systems. Envoy has become the most popular proxy at the edge, and also as the sidecar to handle internal traffic in an Istio service mesh.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Design
Gateway
Analytics
Documentation
Observability

Gateway Capabilities

These are the capabilities the gateway supports.

Mediation
Traffic Management

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1

Custom Code

If they offer plugin, extension, and custom coding options.

WASM

Delivery Models

These are they ways you can deliver this solution.

SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

Circuit Breaker
Conditional Routing
Content-Based Routing
Dynamic Routing
Failover
Ingress Controller
Egress Controller
Load Balancer Routing
Quota
Quota Reset
Rate Limiting
Request Size Limiting
Service Discovery
Throttling
Traffic Optimization

Mediation

CORS
Custom Resources
Request Size Limit
Request Termination
Request Transformation
Response Transformation
URL Rewriting

Security

API Key
API Key Authentication
Access Control Lists (ACL)
Audit Logs
Basic Authentication
CORS
IP Access Rules
JWT Validation
JWT authorizers
Message Inspection
Mutual TLS
OAuth 1.0
OAuth 2.0

Extensions

AWS Integrations
HTTP Callout
HTTP integrations
Kubernetes
Contains
Azure
Google Cloud
Serverless
Open Policy Agent
Service Mesh

API Resources

No API Resources

(Product) (Docs)

{"class":["gateway"],"properties":{"name":"webMethods","provider":"Software AG","slug":"webmethods","rating":2,"license":"Proprietary","status":"Active Research","researchDate":"2021-10","description":"webMethods API Gateway enables an organization to securely expose APIs to external developers, partners, and other consumers for use in building their own applications on their desired platforms. It provides a dedicated, web-based user interface to perform all the administration and API related tasks such as creating APIs, defining and activating policies, creating applications, and consuming APIs. API Gateway gives you rich dashboard capabilities for API Analytics.\n","platformCapabilities":["Gateway","Portal","Threat Protection","Design","Monetization","Analytics"],"gatewayCapabilities":["Mocking","Traffic Management","Mediation","Versioning","Protocol Transformation"],"customCodeSupport":["AWS Lambda","Node.js"],"upstreamProtocols":["HTTP/1.1"],"downstreamProtocols":["HTTP/1.1"],"deliveryModels":["SaaS","Hybrid","Customer Managed (Cloud)","Customer Managed (On-Premises)"],"policies":[{"category":"Security","capabilities":["API Key","OAuth 2.0","SLA Management","WSS Username","Kerberos","SAML","Custom Credentials","LDAP"]},{"category":"Mediation","capabilities":["REST to SOAP","Request Transformation","Response Transformation","XSL Transformation"]},{"category":"Traffic Management","capabilities":["Content-Based Routing","Load Balancer Routing","Conditional Routing","Traffic Optimization","Dynamic Routing","Rate Limiting"]},{"category":"Extensions","capabilities":["Monitoring","Integration Server services"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://www.softwareag.cloud/site/product/webmethods-io-integration.html"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://docs.webmethods.io/api/10.7.0/webmethods_api_cloud__api_gateway_user_s_guide/chapter1/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/webmethods-api-gateway.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/webmethods.png"}]}

webMethods

webMethods API Gateway enables an organization to securely expose APIs to external developers, partners, and other consumers for use in building their own applications on their desired platforms. It provides a dedicated, web-based user interface to perform all the administration and API related tasks such as creating APIs, defining and activating policies, creating applications, and consuming APIs. API Gateway gives you rich dashboard capabilities for API Analytics.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Gateway
Portal
Threat Protection
Design
Monetization
Analytics

Gateway Capabilities

These are the capabilities the gateway supports.

Mocking
Traffic Management
Mediation
Versioning
Protocol Transformation

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1

Custom Code

If they offer plugin, extension, and custom coding options.

AWS Lambda
Node.js

Delivery Models

These are they ways you can deliver this solution.

SaaS
Hybrid
Customer Managed (Cloud)
Customer Managed (On-Premises)

Policies

These are the policies available across the gateway capabilities.

Security

API Key
OAuth 2.0
SLA Management
WSS Username
Kerberos
SAML
Custom Credentials
LDAP

Mediation

REST to SOAP
Request Transformation
Response Transformation
XSL Transformation

Traffic Management

Content-Based Routing
Load Balancer Routing
Conditional Routing
Traffic Optimization
Dynamic Routing
Rate Limiting

Extensions

Monitoring
Integration Server services

API Resources

Service Management OpenAPI	{"openapi":"3.1.0","info":{"title":"Service Management","contact":{},"version":"1.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"http://localhost:5555/rest/apigateway","variables":{}}],"paths":{"/apis/{apiId}/versions":{"get":{"tags":["Versions"],"summary":"Get Versions of API by ID","description":"Retrieve all the versions of the API","operationId":"GetVersionsofAPIbyID","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to retrieve the versions","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"404":{"description":"Not Found","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""}}}},"deprecated":false},"post":{"tags":["Versions"],"summary":"Create Version","description":"Create a new version of an API and retain applications if required","operationId":"CreateVersion","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to be versioned","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CreateVersionRequest"},{"examples":[{"newApiVersion":"2.0","retainApplications":"true"}]}],"contentMediaType":"application/json"},"example":{"newApiVersion":"2.0","retainApplications":"true"}}},"required":true},"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""}}},"401":{"description":"Unauthorized","headers":{},"content":{}},"404":{"description":"Not Found","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/mock/enable":{"put":{"tags":["Mocking"],"summary":"Enable API Mocking","description":"In API Gateway, you can mock an API implementation. API Gateway lets you mock an API by simulating the native service. API Mocking is useful feature in API first approach, where in the provider may choose to expose the mocked API to the consumers when the actual API doesn't exist or isn't complete. \n In API Gateway, when you enable mocking for an API, a default mock response is created for each combination of resource, operation, status code and content-type based on the example and schema set in the API definition. As an API Provider, you can add or modify the default mock responses.\n\nYou can specify conditions at the operation level and configure IS services at the API level for a mocked API in the update API operation. At runtime, when the mocked API is invoked instead of calling the native service, API Gateway returns the mocked response to the consumer based on the below priorities:\n1. If any of the conditions for the invoked operation satisfies, API Gateway returns the associated mocked response.\n2. If no condition is specified or none of the condition for the invoked operation is satisfied, then API Gateway will return \na. the response from an IS service, if an IS service is configured b. default mocked response, if no IS services are configured","operationId":"EnableAPIMocking","parameters":[{"name":"retainDefaultMockResponses","in":"query","description":"Flag to retain generated mocked responses. When this is set to true, default mocked responses will be retained. If it's set to false, new default mocked responses will be generated using the examples, schema in the API","required":true,"style":"form","explode":true,"schema":{"type":"boolean","examples":[false]}},{"name":"apiId","in":"path","description":"(Required) API Id for the API to be activated","required":true,"style":"simple","schema":{"type":"string","examples":["3c575e49-73d5-4ae8-a3a5-552544e5a4a0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"API to demonstrate mocking functionality in international developers day\\\",\\r\\n \\\"version\\\": \\\"v1\\\",\\r\\n \\\"title\\\": \\\"API_MOCKING\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"localhost\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"http\\\"\\r\\n ],\\r\\n \\\"consumes\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/conditionBasedMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Configure condition and mocked response\\\",\\r\\n \\\"operationId\\\": \\\"conditionBasedMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"text/plain\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"text/plain\\\": {\\r\\n \\\"example\\\": \\\"No condition evaluates to true. \\\\nSo API-Gateway sent this default response.\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"text/plain\\\": \\\"No condition evaluates to true. \\\\nSo API-Gateway sent this default response.\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/conditionBasedMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/customESBMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Configure custom ESB mocked response\\\",\\r\\n \\\"operationId\\\": \\\"customESBMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\"\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/customESBMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/dynamicMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Dynamic mocked response set\\\",\\r\\n \\\"operationId\\\": \\\"dynamicMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\"\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/dynamicMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/staticMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Default mocked response from example\\\",\\r\\n \\\"operationId\\\": \\\"generateFromExample\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\",\\r\\n \\\"application/xml\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response generated from example\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"application/json\\\": {\\r\\n \\\"example\\\": \\\"{\\\\\\\"resource\\\\\\\" : \\\\\\\"/generateFromExample\\\\\\\",\\\\\\\"description\\\\\\\" : \\\\\\\"Default mocked response from example for status code 200\\\\\\\"}\\\"\\r\\n },\\r\\n \\\"application/xml\\\": {\\r\\n \\\"example\\\": \\\"<root><resource>/generateFromExample</resource><description>Default mocked response from example for status code 200</description></root>\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"201\\\": {\\r\\n \\\"description\\\": \\\"201 response generated from schema\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"application/json\\\": {\\r\\n \\\"schema\\\": {\\r\\n \\\"$ref\\\": \\\"#/components/schemas/Pet\\\"\\r\\n }\\r\\n },\\r\\n \\\"application/xml\\\": {\\r\\n \\\"schema\\\": {\\r\\n \\\"$ref\\\": \\\"#/components/schemas/Pet\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"{\\\\\\\"resource\\\\\\\" : \\\\\\\"/generateFromExample\\\\\\\",\\\\\\\"description\\\\\\\" : \\\\\\\"Default mocked response from example for status code 200\\\\\\\"}\\\",\\r\\n \\\"application/xml\\\": \\\"<root><resource>/generateFromExample</resource><description>Default mocked response from example for status code 200</description></root>\\\"\\r\\n }\\r\\n },\\r\\n \\\"201\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"{\\\\\\\"birthday\\\\\\\":2059397944,\\\\\\\"name\\\\\\\":\\\\\\\"\\\\\\\"}\\\",\\r\\n \\\"application/xml\\\": \\\"<birthday>921604684</birthday><name/>\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/staticMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"http://localhost\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {\\r\\n \\\"Pet\\\": {\\r\\n \\\"required\\\": [\\r\\n \\\"name\\\"\\r\\n ],\\r\\n \\\"type\\\": \\\"object\\\",\\r\\n \\\"properties\\\": {\\r\\n \\\"birthday\\\": {\\r\\n \\\"type\\\": \\\"integer\\\",\\r\\n \\\"format\\\": \\\"int32\\\"\\r\\n },\\r\\n \\\"name\\\": {\\r\\n \\\"type\\\": \\\"string\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"http://localhost\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"APIMocking\\\",\\r\\n \\\"apiVersion\\\": \\\"v1\\\",\\r\\n \\\"apiDescription\\\": \\\"API to demonstrate mocking functionality in international developers day\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"19773e29-2838-4efc-aa04-793b48f4d22b\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-11-01 13:44:58 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"mockService\\\": {\\r\\n \\\"enableMock\\\": true\\r\\n },\\r\\n \\\"id\\\": \\\"afd8eb5e-bba8-447b-8e28-76aac23ba074\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"v1\\\",\\r\\n \\\"apiId\\\": \\\"afd8eb5e-bba8-447b-8e28-76aac23ba074\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"API to demonstrate mocking functionality in international developers day\\\",\\r\\n \\\"version\\\": \\\"v1\\\",\\r\\n \\\"title\\\": \\\"API_MOCKING\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"localhost\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"http\\\"\\r\\n ],\\r\\n \\\"consumes\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/conditionBasedMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Configure condition and mocked response\\\",\\r\\n \\\"operationId\\\": \\\"conditionBasedMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"text/plain\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"text/plain\\\": {\\r\\n \\\"example\\\": \\\"No condition evaluates to true. \\\\nSo API-Gateway sent this default response.\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"text/plain\\\": \\\"No condition evaluates to true. \\\\nSo API-Gateway sent this default response.\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/conditionBasedMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/customESBMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Configure custom ESB mocked response\\\",\\r\\n \\\"operationId\\\": \\\"customESBMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\"\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/customESBMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/dynamicMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Dynamic mocked response set\\\",\\r\\n \\\"operationId\\\": \\\"dynamicMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\"\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/dynamicMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/staticMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Default mocked response from example\\\",\\r\\n \\\"operationId\\\": \\\"generateFromExample\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\",\\r\\n \\\"application/xml\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response generated from example\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"application/json\\\": {\\r\\n \\\"example\\\": \\\"{\\\\\\\"resource\\\\\\\" : \\\\\\\"/generateFromExample\\\\\\\",\\\\\\\"description\\\\\\\" : \\\\\\\"Default mocked response from example for status code 200\\\\\\\"}\\\"\\r\\n },\\r\\n \\\"application/xml\\\": {\\r\\n \\\"example\\\": \\\"<root><resource>/generateFromExample</resource><description>Default mocked response from example for status code 200</description></root>\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"201\\\": {\\r\\n \\\"description\\\": \\\"201 response generated from schema\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"application/json\\\": {\\r\\n \\\"schema\\\": {\\r\\n \\\"$ref\\\": \\\"#/components/schemas/Pet\\\"\\r\\n }\\r\\n },\\r\\n \\\"application/xml\\\": {\\r\\n \\\"schema\\\": {\\r\\n \\\"$ref\\\": \\\"#/components/schemas/Pet\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"{\\\\\\\"resource\\\\\\\" : \\\\\\\"/generateFromExample\\\\\\\",\\\\\\\"description\\\\\\\" : \\\\\\\"Default mocked response from example for status code 200\\\\\\\"}\\\",\\r\\n \\\"application/xml\\\": \\\"<root><resource>/generateFromExample</resource><description>Default mocked response from example for status code 200</description></root>\\\"\\r\\n }\\r\\n },\\r\\n \\\"201\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"{\\\\\\\"birthday\\\\\\\":2059397944,\\\\\\\"name\\\\\\\":\\\\\\\"\\\\\\\"}\\\",\\r\\n \\\"application/xml\\\": \\\"<birthday>921604684</birthday><name/>\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/staticMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"http://localhost\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {\\r\\n \\\"Pet\\\": {\\r\\n \\\"required\\\": [\\r\\n \\\"name\\\"\\r\\n ],\\r\\n \\\"type\\\": \\\"object\\\",\\r\\n \\\"properties\\\": {\\r\\n \\\"birthday\\\": {\\r\\n \\\"type\\\": \\\"integer\\\",\\r\\n \\\"format\\\": \\\"int32\\\"\\r\\n },\\r\\n \\\"name\\\": {\\r\\n \\\"type\\\": \\\"string\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"http://localhost\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"APIMocking\\\",\\r\\n \\\"apiVersion\\\": \\\"v1\\\",\\r\\n \\\"apiDescription\\\": \\\"API to demonstrate mocking functionality in international developers day\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"19773e29-2838-4efc-aa04-793b48f4d22b\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-11-01 13:44:58 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"mockService\\\": {\\r\\n \\\"enableMock\\\": true\\r\\n },\\r\\n \\\"id\\\": \\\"afd8eb5e-bba8-447b-8e28-76aac23ba074\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"v1\\\",\\r\\n \\\"apiId\\\": \\\"afd8eb5e-bba8-447b-8e28-76aac23ba074\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""}}},"404":{"description":"Not Found","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/mock/disable":{"put":{"tags":["Mocking"],"summary":"Disable API Mocking","description":"Once API is disabled from mocking capability, at runtime all the API invocations are redirected to the native service instead of sending the mocked response","operationId":"DisableAPIMocking","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to be deactivated","required":true,"style":"simple","schema":{"type":"string","examples":["3c575e49-73d5-4ae8-a3a5-552544e5a4a0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"400":{"description":"Bad Request","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"API to demonstrate mocking functionality in international developers day\\\",\\r\\n \\\"version\\\": \\\"v1\\\",\\r\\n \\\"title\\\": \\\"API_MOCKING\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"localhost\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"http\\\"\\r\\n ],\\r\\n \\\"consumes\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/conditionBasedMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Configure condition and mocked response\\\",\\r\\n \\\"operationId\\\": \\\"conditionBasedMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"text/plain\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"text/plain\\\": {\\r\\n \\\"example\\\": \\\"No condition evaluates to true. \\\\nSo API-Gateway sent this default response.\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"text/plain\\\": \\\"No condition evaluates to true. \\\\nSo API-Gateway sent this default response.\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/conditionBasedMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/customESBMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Configure custom ESB mocked response\\\",\\r\\n \\\"operationId\\\": \\\"customESBMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\"\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/customESBMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/dynamicMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Dynamic mocked response set\\\",\\r\\n \\\"operationId\\\": \\\"dynamicMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\"\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/dynamicMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/staticMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Default mocked response from example\\\",\\r\\n \\\"operationId\\\": \\\"generateFromExample\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\",\\r\\n \\\"application/xml\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response generated from example\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"application/json\\\": {\\r\\n \\\"example\\\": \\\"{\\\\\\\"resource\\\\\\\" : \\\\\\\"/generateFromExample\\\\\\\",\\\\\\\"description\\\\\\\" : \\\\\\\"Default mocked response from example for status code 200\\\\\\\"}\\\"\\r\\n },\\r\\n \\\"application/xml\\\": {\\r\\n \\\"example\\\": \\\"<root><resource>/generateFromExample</resource><description>Default mocked response from example for status code 200</description></root>\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"201\\\": {\\r\\n \\\"description\\\": \\\"201 response generated from schema\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"application/json\\\": {\\r\\n \\\"schema\\\": {\\r\\n \\\"$ref\\\": \\\"#/components/schemas/Pet\\\"\\r\\n }\\r\\n },\\r\\n \\\"application/xml\\\": {\\r\\n \\\"schema\\\": {\\r\\n \\\"$ref\\\": \\\"#/components/schemas/Pet\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"{\\\\\\\"resource\\\\\\\" : \\\\\\\"/generateFromExample\\\\\\\",\\\\\\\"description\\\\\\\" : \\\\\\\"Default mocked response from example for status code 200\\\\\\\"}\\\",\\r\\n \\\"application/xml\\\": \\\"<root><resource>/generateFromExample</resource><description>Default mocked response from example for status code 200</description></root>\\\"\\r\\n }\\r\\n },\\r\\n \\\"201\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"{\\\\\\\"birthday\\\\\\\":2059397944,\\\\\\\"name\\\\\\\":\\\\\\\"\\\\\\\"}\\\",\\r\\n \\\"application/xml\\\": \\\"<birthday>921604684</birthday><name/>\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/staticMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"http://localhost\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {\\r\\n \\\"Pet\\\": {\\r\\n \\\"required\\\": [\\r\\n \\\"name\\\"\\r\\n ],\\r\\n \\\"type\\\": \\\"object\\\",\\r\\n \\\"properties\\\": {\\r\\n \\\"birthday\\\": {\\r\\n \\\"type\\\": \\\"integer\\\",\\r\\n \\\"format\\\": \\\"int32\\\"\\r\\n },\\r\\n \\\"name\\\": {\\r\\n \\\"type\\\": \\\"string\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"http://localhost\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"APIMocking\\\",\\r\\n \\\"apiVersion\\\": \\\"v1\\\",\\r\\n \\\"apiDescription\\\": \\\"API to demonstrate mocking functionality in international developers day\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"19773e29-2838-4efc-aa04-793b48f4d22b\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-11-01 13:44:58 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"mockService\\\": {\\r\\n \\\"enableMock\\\": false\\r\\n },\\r\\n \\\"id\\\": \\\"afd8eb5e-bba8-447b-8e28-76aac23ba074\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"v1\\\",\\r\\n \\\"apiId\\\": \\\"afd8eb5e-bba8-447b-8e28-76aac23ba074\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"API to demonstrate mocking functionality in international developers day\\\",\\r\\n \\\"version\\\": \\\"v1\\\",\\r\\n \\\"title\\\": \\\"API_MOCKING\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"localhost\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"http\\\"\\r\\n ],\\r\\n \\\"consumes\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/conditionBasedMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Configure condition and mocked response\\\",\\r\\n \\\"operationId\\\": \\\"conditionBasedMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"text/plain\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"text/plain\\\": {\\r\\n \\\"example\\\": \\\"No condition evaluates to true. \\\\nSo API-Gateway sent this default response.\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"text/plain\\\": \\\"No condition evaluates to true. \\\\nSo API-Gateway sent this default response.\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/conditionBasedMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/customESBMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Configure custom ESB mocked response\\\",\\r\\n \\\"operationId\\\": \\\"customESBMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\"\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/customESBMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/dynamicMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Dynamic mocked response set\\\",\\r\\n \\\"operationId\\\": \\\"dynamicMockedResponse\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response\\\"\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/dynamicMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"/staticMockedResponse\\\": {\\r\\n \\\"post\\\": {\\r\\n \\\"summary\\\": \\\"Default mocked response from example\\\",\\r\\n \\\"operationId\\\": \\\"generateFromExample\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\",\\r\\n \\\"application/xml\\\"\\r\\n ],\\r\\n \\\"responses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"description\\\": \\\"200 response generated from example\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"application/json\\\": {\\r\\n \\\"example\\\": \\\"{\\\\\\\"resource\\\\\\\" : \\\\\\\"/generateFromExample\\\\\\\",\\\\\\\"description\\\\\\\" : \\\\\\\"Default mocked response from example for status code 200\\\\\\\"}\\\"\\r\\n },\\r\\n \\\"application/xml\\\": {\\r\\n \\\"example\\\": \\\"<root><resource>/generateFromExample</resource><description>Default mocked response from example for status code 200</description></root>\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"201\\\": {\\r\\n \\\"description\\\": \\\"201 response generated from schema\\\",\\r\\n \\\"content\\\": {\\r\\n \\\"application/json\\\": {\\r\\n \\\"schema\\\": {\\r\\n \\\"$ref\\\": \\\"#/components/schemas/Pet\\\"\\r\\n }\\r\\n },\\r\\n \\\"application/xml\\\": {\\r\\n \\\"schema\\\": {\\r\\n \\\"$ref\\\": \\\"#/components/schemas/Pet\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"mockedResponses\\\": {\\r\\n \\\"200\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"{\\\\\\\"resource\\\\\\\" : \\\\\\\"/generateFromExample\\\\\\\",\\\\\\\"description\\\\\\\" : \\\\\\\"Default mocked response from example for status code 200\\\\\\\"}\\\",\\r\\n \\\"application/xml\\\": \\\"<root><resource>/generateFromExample</resource><description>Default mocked response from example for status code 200</description></root>\\\"\\r\\n }\\r\\n },\\r\\n \\\"201\\\": {\\r\\n \\\"responseBody\\\": {\\r\\n \\\"application/json\\\": \\\"{\\\\\\\"birthday\\\\\\\":2059397944,\\\\\\\"name\\\\\\\":\\\\\\\"\\\\\\\"}\\\",\\r\\n \\\"application/xml\\\": \\\"<birthday>921604684</birthday><name/>\\\"\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"parameters\\\": [],\\r\\n \\\"displayName\\\": \\\"/staticMockedResponse\\\",\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"http://localhost\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {\\r\\n \\\"Pet\\\": {\\r\\n \\\"required\\\": [\\r\\n \\\"name\\\"\\r\\n ],\\r\\n \\\"type\\\": \\\"object\\\",\\r\\n \\\"properties\\\": {\\r\\n \\\"birthday\\\": {\\r\\n \\\"type\\\": \\\"integer\\\",\\r\\n \\\"format\\\": \\\"int32\\\"\\r\\n },\\r\\n \\\"name\\\": {\\r\\n \\\"type\\\": \\\"string\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"http://localhost\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"APIMocking\\\",\\r\\n \\\"apiVersion\\\": \\\"v1\\\",\\r\\n \\\"apiDescription\\\": \\\"API to demonstrate mocking functionality in international developers day\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"19773e29-2838-4efc-aa04-793b48f4d22b\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-11-01 13:44:58 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"mockService\\\": {\\r\\n \\\"enableMock\\\": false\\r\\n },\\r\\n \\\"id\\\": \\\"afd8eb5e-bba8-447b-8e28-76aac23ba074\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"v1\\\",\\r\\n \\\"apiId\\\": \\\"afd8eb5e-bba8-447b-8e28-76aac23ba074\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""}}},"404":{"description":"Not Found","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/scopes":{"get":{"tags":["Scopes"],"summary":"Get Scopes of API by API Id","description":"An API Scope is a collection of resources or operations in an API. Users can create multiple scopes for a single API. Policies can be attached to an API level or scope level. This method retrieves the scopes of an API.\n\nYou can create, modify or delete the scopes in the update API operation using PUT /api/{apiId}","operationId":"GetScopesofAPIbyAPIId","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to retrieve the versions","required":true,"style":"simple","schema":{"type":"string","examples":["3c575e49-73d5-4ae8-a3a5-552544e5a4a0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"404":{"description":"Not Found","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"scopeReferences\\\": [\\r\\n {\\r\\n \\\"references\\\": [\\r\\n {\\r\\n \\\"resourcePath\\\": \\\"/random\\\",\\r\\n \\\"supportedOperations\\\": []\\r\\n }\\r\\n ],\\r\\n \\\"scope\\\": {\\r\\n \\\"name\\\": \\\"Get_Scopes\\\",\\r\\n \\\"description\\\": \\\"Dummy description of the scope\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\\\"\\r\\n ]\\r\\n }\\r\\n }\\r\\n ]\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"scopeReferences\\\": [\\r\\n {\\r\\n \\\"references\\\": [\\r\\n {\\r\\n \\\"resourcePath\\\": \\\"/random\\\",\\r\\n \\\"supportedOperations\\\": []\\r\\n }\\r\\n ],\\r\\n \\\"scope\\\": {\\r\\n \\\"name\\\": \\\"Get_Scopes\\\",\\r\\n \\\"description\\\": \\\"Dummy description of the scope\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\\\"\\r\\n ]\\r\\n }\\r\\n }\\r\\n ]\\r\\n}\""}}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/scopes/{scopeName}":{"get":{"tags":["Scopes"],"summary":"Get Scope of API By API Id and Scope Name","description":"Retrieve scopes of an API based on the scope name","operationId":"GetScopeofAPIByAPIIdandScopeName","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to retrieve the versions","required":true,"style":"simple","schema":{"type":"string","examples":["3c575e49-73d5-4ae8-a3a5-552544e5a4a0"]}},{"name":"scopeName","in":"path","description":"(Required) Name of the scope","required":true,"style":"simple","schema":{"type":"string","examples":["Pet Scope"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"404":{"description":"Not Found","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"scopeReferences\\\": [\\r\\n {\\r\\n \\\"references\\\": [\\r\\n {\\r\\n \\\"resourcePath\\\": \\\"/random\\\",\\r\\n \\\"supportedOperations\\\": []\\r\\n }\\r\\n ],\\r\\n \\\"scope\\\": {\\r\\n \\\"name\\\": \\\"Get_Scopes\\\",\\r\\n \\\"description\\\": \\\"Dummy description of the scope\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\\\"\\r\\n ]\\r\\n }\\r\\n }\\r\\n ]\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"scopeReferences\\\": [\\r\\n {\\r\\n \\\"references\\\": [\\r\\n {\\r\\n \\\"resourcePath\\\": \\\"/random\\\",\\r\\n \\\"supportedOperations\\\": []\\r\\n }\\r\\n ],\\r\\n \\\"scope\\\": {\\r\\n \\\"name\\\": \\\"Get_Scopes\\\",\\r\\n \\\"description\\\": \\\"Dummy description of the scope\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\\\"\\r\\n ]\\r\\n }\\r\\n }\\r\\n ]\\r\\n}\""}}}},"deprecated":false},"parameters":[]},"/apis/{apiId}":{"get":{"tags":["APIs"],"summary":"Get API Details by Id","description":"Retrieve an API based on the API id.","operationId":"GetAPIDetailsbyId","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to be retrieved","required":true,"style":"simple","schema":{"type":"string","examples":["3c575e49-73d5-4ae8-a3a5-552544e5a4a0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"404":{"description":"Not Found","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n \\r\\n }\\r\\n ],\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ] }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n \\r\\n }\\r\\n ],\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ] }\\r\\n}\""}}}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Delete API by Id","description":"Delete the inactive API","operationId":"DeleteAPIbyId","parameters":[{"name":"forceDelete","in":"query","description":"Flag for force delete. Required when API is associated with some applications","required":true,"style":"form","explode":true,"schema":{"type":"boolean","examples":[true]}},{"name":"apiId","in":"path","description":"(Required) API Id for the API to be deleted","required":true,"style":"simple","schema":{"type":"string","examples":["3c575e49-73d5-4ae8-a3a5-552544e5a4a0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"400":{"description":"Bad Request","headers":{},"content":{}},"404":{"description":"Not Found","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReturnstheapiIdalongwiththeerrorwhenunsuccessful"},{"examples":[{"id":"<string>","apiName":"<string>","apiVersion":"<string>","type":"<string>","publishedPortals":["<string>","<string>"],"systemVersion":"<integer>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"active":"<boolean>","apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"}]}],"contentMediaType":"application/json"},"example":{"id":"<string>","apiName":"<string>","apiVersion":"<string>","type":"<string>","publishedPortals":["<string>","<string>"],"systemVersion":"<integer>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"active":"<boolean>","apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"}}}},"204":{"description":"No Content","headers":{},"content":{}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/activate":{"put":{"tags":["APIs"],"summary":"Activate API","description":"Activate an API so that API is exposed to consumers","operationId":"ActivateAPI","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to be activated","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"400":{"description":"Bad Request","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}},"404":{"description":"Not Found","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""}}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/deactivate":{"put":{"tags":["APIs"],"summary":"Deactivate API","description":"Deactivate an API so that API is not exposed to consumers","operationId":"DeactivateAPI","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to be deactivated","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""}}},"404":{"description":"Not Found","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/publish":{"put":{"tags":["APIs"],"summary":"Publish API","description":"This REST operation is used to publish API to the registered API Portal","operationId":"PublishAPI","parameters":[{"name":"portalGatewayId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","examples":["d663e093-b39a-4330-93b9-fcb68d1a2c3d"]}},{"name":"apiId","in":"path","description":"(Required) API Id for the API to be published","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PublishAPIRequest"},{"examples":[{"communities":["3bdf8005-5685-3ef5-b132-de4681963fb6"],"endpoints":["http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5"]}]}],"contentMediaType":"application/json"},"example":{"communities":["3bdf8005-5685-3ef5-b132-de4681963fb6"],"endpoints":["http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5"]}}},"required":true},"responses":{"404":{"description":"Not Found","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"vendorExtensions\\\": {},\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"parameters\\\": [],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"definitions\\\": {}\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"879068cd-8628-4f2a-b903-4e6613ca12ba\\\"\\r\\n ],\\r\\n \\\"referencedFiles\\\": {\\r\\n \\\"ChuckNorrisAPI.json\\\": \\\"{\\\\r\\\\n \\\\\\\"swagger\\\\\\\": \\\\\\\"2.0\\\\\\\",\\\\r\\\\n \\\\\\\"info\\\\\\\": {\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\\\\\",\\\\r\\\\n \\\\\\\"title\\\\\\\": \\\\\\\"ChuckNorrisAPI\\\\\\\",\\\\r\\\\n \\\\\\\"version\\\\\\\": \\\\\\\"1.0\\\\\\\"\\\\r\\\\n },\\\\r\\\\n \\\\\\\"host\\\\\\\": \\\\\\\"api.chucknorris.io\\\\\\\",\\\\r\\\\n \\\\\\\"basePath\\\\\\\": \\\\\\\"/jokes\\\\\\\",\\\\r\\\\n \\\\\\\"schemes\\\\\\\": [\\\\r\\\\n \\\\\\\"https\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"paths\\\\\\\": {\\\\r\\\\n \\\\\\\"/random\\\\\\\": {\\\\r\\\\n \\\\\\\"get\\\\\\\": {\\\\r\\\\n \\\\\\\"summary\\\\\\\": \\\\\\\"GET\\\\\\\",\\\\r\\\\n \\\\\\\"deprecated\\\\\\\": false,\\\\r\\\\n \\\\\\\"produces\\\\\\\": [\\\\r\\\\n \\\\\\\"application/json\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"\\\\\\\",\\\\r\\\\n \\\\\\\"operationId\\\\\\\": \\\\\\\"GET\\\\\\\"\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\"\\r\\n },\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2017-03-13 09:38:30 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\",\\r\\n \\\"oauth2ScopeName\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"vendorExtensions\\\": {},\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"parameters\\\": [],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"definitions\\\": {}\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"879068cd-8628-4f2a-b903-4e6613ca12ba\\\"\\r\\n ],\\r\\n \\\"referencedFiles\\\": {\\r\\n \\\"ChuckNorrisAPI.json\\\": \\\"{\\\\r\\\\n \\\\\\\"swagger\\\\\\\": \\\\\\\"2.0\\\\\\\",\\\\r\\\\n \\\\\\\"info\\\\\\\": {\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\\\\\",\\\\r\\\\n \\\\\\\"title\\\\\\\": \\\\\\\"ChuckNorrisAPI\\\\\\\",\\\\r\\\\n \\\\\\\"version\\\\\\\": \\\\\\\"1.0\\\\\\\"\\\\r\\\\n },\\\\r\\\\n \\\\\\\"host\\\\\\\": \\\\\\\"api.chucknorris.io\\\\\\\",\\\\r\\\\n \\\\\\\"basePath\\\\\\\": \\\\\\\"/jokes\\\\\\\",\\\\r\\\\n \\\\\\\"schemes\\\\\\\": [\\\\r\\\\n \\\\\\\"https\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"paths\\\\\\\": {\\\\r\\\\n \\\\\\\"/random\\\\\\\": {\\\\r\\\\n \\\\\\\"get\\\\\\\": {\\\\r\\\\n \\\\\\\"summary\\\\\\\": \\\\\\\"GET\\\\\\\",\\\\r\\\\n \\\\\\\"deprecated\\\\\\\": false,\\\\r\\\\n \\\\\\\"produces\\\\\\\": [\\\\r\\\\n \\\\\\\"application/json\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"\\\\\\\",\\\\r\\\\n \\\\\\\"operationId\\\\\\\": \\\\\\\"GET\\\\\\\"\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\"\\r\\n },\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2017-03-13 09:38:30 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\",\\r\\n \\\"oauth2ScopeName\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n }\\r\\n}\""}}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/unpublish":{"put":{"tags":["APIs"],"summary":"Unpublish API","description":"Unpublish API from the registered API Portal","operationId":"UnpublishAPI","parameters":[{"name":"portalGatewayId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","examples":["d663e093-b39a-4330-93b9-fcb68d1a2c3d"]}},{"name":"forceUnpublish","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"boolean","examples":[true]}},{"name":"apiId","in":"path","description":"(Required) API Id for the API to be unpublished","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"404":{"description":"Not Found","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"vendorExtensions\\\": {},\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"parameters\\\": [],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"definitions\\\": {}\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"879068cd-8628-4f2a-b903-4e6613ca12ba\\\"\\r\\n ],\\r\\n \\\"referencedFiles\\\": {\\r\\n \\\"ChuckNorrisAPI.json\\\": \\\"{\\\\r\\\\n \\\\\\\"swagger\\\\\\\": \\\\\\\"2.0\\\\\\\",\\\\r\\\\n \\\\\\\"info\\\\\\\": {\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\\\\\",\\\\r\\\\n \\\\\\\"title\\\\\\\": \\\\\\\"ChuckNorrisAPI\\\\\\\",\\\\r\\\\n \\\\\\\"version\\\\\\\": \\\\\\\"1.0\\\\\\\"\\\\r\\\\n },\\\\r\\\\n \\\\\\\"host\\\\\\\": \\\\\\\"api.chucknorris.io\\\\\\\",\\\\r\\\\n \\\\\\\"basePath\\\\\\\": \\\\\\\"/jokes\\\\\\\",\\\\r\\\\n \\\\\\\"schemes\\\\\\\": [\\\\r\\\\n \\\\\\\"https\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"paths\\\\\\\": {\\\\r\\\\n \\\\\\\"/random\\\\\\\": {\\\\r\\\\n \\\\\\\"get\\\\\\\": {\\\\r\\\\n \\\\\\\"summary\\\\\\\": \\\\\\\"GET\\\\\\\",\\\\r\\\\n \\\\\\\"deprecated\\\\\\\": false,\\\\r\\\\n \\\\\\\"produces\\\\\\\": [\\\\r\\\\n \\\\\\\"application/json\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"\\\\\\\",\\\\r\\\\n \\\\\\\"operationId\\\\\\\": \\\\\\\"GET\\\\\\\"\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\"\\r\\n },\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2017-03-13 09:38:30 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\",\\r\\n \\\"oauth2ScopeName\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"vendorExtensions\\\": {},\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"parameters\\\": [],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"definitions\\\": {}\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"879068cd-8628-4f2a-b903-4e6613ca12ba\\\"\\r\\n ],\\r\\n \\\"referencedFiles\\\": {\\r\\n \\\"ChuckNorrisAPI.json\\\": \\\"{\\\\r\\\\n \\\\\\\"swagger\\\\\\\": \\\\\\\"2.0\\\\\\\",\\\\r\\\\n \\\\\\\"info\\\\\\\": {\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\\\\\",\\\\r\\\\n \\\\\\\"title\\\\\\\": \\\\\\\"ChuckNorrisAPI\\\\\\\",\\\\r\\\\n \\\\\\\"version\\\\\\\": \\\\\\\"1.0\\\\\\\"\\\\r\\\\n },\\\\r\\\\n \\\\\\\"host\\\\\\\": \\\\\\\"api.chucknorris.io\\\\\\\",\\\\r\\\\n \\\\\\\"basePath\\\\\\\": \\\\\\\"/jokes\\\\\\\",\\\\r\\\\n \\\\\\\"schemes\\\\\\\": [\\\\r\\\\n \\\\\\\"https\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"paths\\\\\\\": {\\\\r\\\\n \\\\\\\"/random\\\\\\\": {\\\\r\\\\n \\\\\\\"get\\\\\\\": {\\\\r\\\\n \\\\\\\"summary\\\\\\\": \\\\\\\"GET\\\\\\\",\\\\r\\\\n \\\\\\\"deprecated\\\\\\\": false,\\\\r\\\\n \\\\\\\"produces\\\\\\\": [\\\\r\\\\n \\\\\\\"application/json\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"\\\\\\\",\\\\r\\\\n \\\\\\\"operationId\\\\\\\": \\\\\\\"GET\\\\\\\"\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\"\\r\\n },\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2017-03-13 09:38:30 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\",\\r\\n \\\"oauth2ScopeName\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n }\\r\\n}\""}}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/implementation":{"put":{"tags":["APIs"],"summary":"Notify API Implementation","description":"An API Provider tool can use this operation to update the API in APIGateway after completion of its implementation in their end","operationId":"NotifyAPIImplementation","parameters":[{"name":"nativeBaseURL","in":"query","description":"Base URL of the native API","required":true,"style":"form","explode":true,"schema":{"type":"string","examples":["http://petstore.swagger.io/v2"]}},{"name":"overwriteAlias","in":"query","description":"Flag to replace the endpoint alias that is used in the routing policy of the API with the given value of 'nativeBaseURL' parameter.","required":true,"style":"form","explode":true,"schema":{"type":"boolean","examples":[false]}},{"name":"maturityState","in":"query","description":"Value of the 'maturity state' attribute of the API. The 'maturity state' of the API can be set to its one of possible value (from its defines values in extended settings configuration) to depict the completion its implementation","required":true,"style":"form","explode":true,"schema":{"type":"string","examples":["Beta"]}},{"name":"apiId","in":"path","description":"(Required) API Id for the API to be updated","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"404":{"description":"Not Found","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReturnstheupdatedAPIobject"},{"examples":[{"apiId":"<string>","api":{"apiDefinition":{"type":"<string>","description":"<string>","title":"<string>","version":"<string>","uri":["<string>"],"serviceRegistryDisplayName":"<string>"},"nativeEndpoint":[{"optimizationTechnique":"<string>","passSecurityHeaders":"<boolean>","uri":"<string>","connectionTimeoutDuration":"<integer>","alias":"<boolean>"}],"apiName":"<string>","apiVersion":"<string>","apiEndpointPrefix":"<string>","apiDescription":"<string>","maturityState":"<string>","apiGroups":["<string>","<string>"],"isActive":"<boolean>","type":"<string>","owner":"<string>","policies":["<string>","<string>"],"rootFileName":"<string>","scopes":[{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"},{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"}],"publishedPortals":["<string>","<string>"],"publishedToRegistry":"<boolean>","creationDate":"<string>","lastModified":"<string>","prevVersion":"<string>","nextVersion":"<string>","systemVersion":"<integer>","provider":"<string>","centraSiteURL":"<string>","mockService":{"enableMock":"<boolean>","runAsUser":"<string>","service":"<string>"},"apiDocuments":["<string>","<string>"],"id":"<string>","oauth2ScopeName":"<string>"},"responseStatus":"<string>","errorReason":"<string>","gatewayEndPoints":["<string>","<string>"],"microgatewayEndPoints":["<string>","<string>"],"reason":"<object>","pubSOAPFlavor":"<string>","restrictViewAsset":"<boolean>","rootFileLocation":"<string>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"portalGatewayDataEntries":"<object>"}]}],"contentMediaType":"application/json"},"example":{"apiId":"<string>","api":{"apiDefinition":{"type":"<string>","description":"<string>","title":"<string>","version":"<string>","uri":["<string>"],"serviceRegistryDisplayName":"<string>"},"nativeEndpoint":[{"optimizationTechnique":"<string>","passSecurityHeaders":"<boolean>","uri":"<string>","connectionTimeoutDuration":"<integer>","alias":"<boolean>"}],"apiName":"<string>","apiVersion":"<string>","apiEndpointPrefix":"<string>","apiDescription":"<string>","maturityState":"<string>","apiGroups":["<string>","<string>"],"isActive":"<boolean>","type":"<string>","owner":"<string>","policies":["<string>","<string>"],"rootFileName":"<string>","scopes":[{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"},{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"}],"publishedPortals":["<string>","<string>"],"publishedToRegistry":"<boolean>","creationDate":"<string>","lastModified":"<string>","prevVersion":"<string>","nextVersion":"<string>","systemVersion":"<integer>","provider":"<string>","centraSiteURL":"<string>","mockService":{"enableMock":"<boolean>","runAsUser":"<string>","service":"<string>"},"apiDocuments":["<string>","<string>"],"id":"<string>","oauth2ScopeName":"<string>"},"responseStatus":"<string>","errorReason":"<string>","gatewayEndPoints":["<string>","<string>"],"microgatewayEndPoints":["<string>","<string>"],"reason":"<object>","pubSOAPFlavor":"<string>","restrictViewAsset":"<boolean>","rootFileLocation":"<string>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"portalGatewayDataEntries":"<object>"}}}},"401":{"description":"Unauthorized","headers":{},"content":{}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/applications":{"get":{"tags":["APIs"],"summary":"Get Applications associated with API","description":"Retrieves the list of registered applications of an API","operationId":"GetApplicationsassociatedwithAPI","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to find the associated applications","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"applications\\\": [\\r\\n {\\r\\n \\\"name\\\": \\\"app1\\\",\\r\\n \\\"description\\\": null,\\r\\n \\\"contactEmails\\\": [],\\r\\n \\\"identifiers\\\": [],\\r\\n \\\"siteURLs\\\": [],\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"id\\\": \\\"ae48cd69-421e-4bdf-a4d0-e86996a78f68\\\",\\r\\n \\\"created\\\": \\\"2017-03-13 13:12:03 GMT\\\",\\r\\n \\\"lastupdated\\\": null,\\r\\n \\\"consumingAPIs\\\": [\\r\\n \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n ],\\r\\n \\\"accessTokens\\\": {\\r\\n \\\"apiAccessKey_credentials\\\": {\\r\\n \\\"apiAccessKey\\\": \\\"cec4b46b-3569-4f73-a561-172dd67c182a\\\",\\r\\n \\\"expirationInterval\\\": null\\r\\n },\\r\\n \\\"oauth_credentials\\\": {\\r\\n \\\"clientID\\\": \\\"40b78ed3-d171-4bd3-99db-51dd2fa71753\\\",\\r\\n \\\"clientSecret\\\": \\\"024b9525-6526-45c8-a66c-d192442064e1\\\",\\r\\n \\\"clientName\\\": \\\"app1-6b753c2a-0567-462d-a4ea-1b143ab7a381\\\",\\r\\n \\\"scopes\\\": [\\r\\n \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n ],\\r\\n \\\"token_lifetime\\\": \\\"3600\\\",\\r\\n \\\"token_refresh_limit\\\": \\\"0\\\",\\r\\n \\\"redirect_uris\\\": [\\r\\n \\\"https://placeholder_redirect_uri\\\"\\r\\n ],\\r\\n \\\"Type\\\": \\\"confidential\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n ]\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"applications\\\": [\\r\\n {\\r\\n \\\"name\\\": \\\"app1\\\",\\r\\n \\\"description\\\": null,\\r\\n \\\"contactEmails\\\": [],\\r\\n \\\"identifiers\\\": [],\\r\\n \\\"siteURLs\\\": [],\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"id\\\": \\\"ae48cd69-421e-4bdf-a4d0-e86996a78f68\\\",\\r\\n \\\"created\\\": \\\"2017-03-13 13:12:03 GMT\\\",\\r\\n \\\"lastupdated\\\": null,\\r\\n \\\"consumingAPIs\\\": [\\r\\n \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n ],\\r\\n \\\"accessTokens\\\": {\\r\\n \\\"apiAccessKey_credentials\\\": {\\r\\n \\\"apiAccessKey\\\": \\\"cec4b46b-3569-4f73-a561-172dd67c182a\\\",\\r\\n \\\"expirationInterval\\\": null\\r\\n },\\r\\n \\\"oauth_credentials\\\": {\\r\\n \\\"clientID\\\": \\\"40b78ed3-d171-4bd3-99db-51dd2fa71753\\\",\\r\\n \\\"clientSecret\\\": \\\"024b9525-6526-45c8-a66c-d192442064e1\\\",\\r\\n \\\"clientName\\\": \\\"app1-6b753c2a-0567-462d-a4ea-1b143ab7a381\\\",\\r\\n \\\"scopes\\\": [\\r\\n \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n ],\\r\\n \\\"token_lifetime\\\": \\\"3600\\\",\\r\\n \\\"token_refresh_limit\\\": \\\"0\\\",\\r\\n \\\"redirect_uris\\\": [\\r\\n \\\"https://placeholder_redirect_uri\\\"\\r\\n ],\\r\\n \\\"Type\\\": \\\"confidential\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n ]\\r\\n}\""}}},"404":{"description":"Not Found","headers":{},"content":{}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/source":{"get":{"tags":["APIs"],"summary":"Get Source","description":"Download the API definition that was used to create the API. This is applicable only for SOAP APIs.","operationId":"GetSource","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to download the source content","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}},"404":{"description":"Not Found","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"multipart/mixed":{"schema":{"type":"string","examples":["Message-ID: <296841806.5.1489555643275.JavaMail.MRIZ@MCMRIZ01>\r\nMIME-Version: 1.0\r\nContent-Type: multipart/mixed; \r\n\tboundary=\"----=_Part_4_1098332532.1489555643274\"\r\n\r\n------=_Part_4_1098332532.1489555643274\r\ncontent-type: application/zip\r\nContent-Disposition: attachment; filename=\"echoService.zip\"\r\n\r\nfile content in zip format\r\n------=_Part_4_1098332532.1489555643274\r\ncontent-type: text/plain\r\nContent-Disposition: inline; name=\"rootFileName\"\r\n\r\necho.wsdl\r\n------=_Part_4_1098332532.1489555643274--"],"contentMediaType":"multipart/mixed"},"example":"Message-ID: <296841806.5.1489555643275.JavaMail.MRIZ@MCMRIZ01>\r\nMIME-Version: 1.0\r\nContent-Type: multipart/mixed; \r\n\tboundary=\"----=_Part_4_1098332532.1489555643274\"\r\n\r\n------=_Part_4_1098332532.1489555643274\r\ncontent-type: application/zip\r\nContent-Disposition: attachment; filename=\"echoService.zip\"\r\n\r\nfile content in zip format\r\n------=_Part_4_1098332532.1489555643274\r\ncontent-type: text/plain\r\nContent-Disposition: inline; name=\"rootFileName\"\r\n\r\necho.wsdl\r\n------=_Part_4_1098332532.1489555643274--"}}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/globalPolicies":{"get":{"tags":["APIs"],"summary":"Get Associated Global Policies","description":"Retrieves the list of active global policies applicable to this API","operationId":"GetAssociatedGlobalPolicies","parameters":[{"name":"apiId","in":"path","description":"(Required) API Id for the API to find the list of applicable global policies","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"404":{"description":"Not Found","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"globalPolicies\\\": [\\r\\n \\\"GlobalLogInvocationPolicy\\\"\\r\\n ]\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"globalPolicies\\\": [\\r\\n \\\"GlobalLogInvocationPolicy\\\"\\r\\n ]\\r\\n}\""}}}},"deprecated":false},"parameters":[]},"/apis/{apiId}/providerspecification":{"get":{"tags":["APIs"],"summary":"Download Provider Specification","description":"Downloads the provider specification of REST and SOAP based APIs. Provider specification is nothing but, the specification file (in swagger or wsdl format) with out the concrete API Gateway endpoint and contains all resources/methods/operation irrespective of whether they are exposed to consumer","operationId":"DownloadProviderSpecification","parameters":[{"name":"format","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","examples":["swagger"]}},{"name":"apiId","in":"path","description":"(Required) API Id for the API to retrieve the versions","required":true,"style":"simple","schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"404":{"description":"Not Found","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Iftheformatisswaggerreturnstheswaggercontentinjson.Iftheformatiswsdlreturnsthewsdlcontentinxml."},{"examples":[{"versions":[{"versionNumber":"<string>","apiId":"<string>"},{"versionNumber":"<string>","apiId":"<string>"}],"gatewayEndPoints":["<string>","<string>"],"api":{"apiDefinition":{"type":"<string>","description":"<string>","title":"<string>","version":"<string>","uri":["<string>"],"serviceRegistryDisplayName":"<string>"},"nativeEndpoint":[{"optimizationTechnique":"<string>","passSecurityHeaders":"<boolean>","uri":"<string>","connectionTimeoutDuration":"<integer>","alias":"<boolean>"}],"apiName":"<string>","apiVersion":"<string>","apiEndpointPrefix":"<string>","apiDescription":"<string>","maturityState":"<string>","apiGroups":["<string>","<string>"],"isActive":"<boolean>","type":"<string>","owner":"<string>","policies":["<string>","<string>"],"rootFileName":"<string>","scopes":[{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"},{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"}],"publishedPortals":["<string>","<string>"],"publishedToRegistry":"<boolean>","creationDate":"<string>","lastModified":"<string>","prevVersion":"<string>","nextVersion":"<string>","systemVersion":"<integer>","provider":"<string>","centraSiteURL":"<string>","mockService":{"enableMock":"<boolean>","runAsUser":"<string>","service":"<string>"},"apiDocuments":["<string>","<string>"],"id":"<string>","oauth2ScopeName":"<string>"},"apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"}]}],"contentMediaType":"application/json"},"example":{"versions":[{"versionNumber":"<string>","apiId":"<string>"},{"versionNumber":"<string>","apiId":"<string>"}],"gatewayEndPoints":["<string>","<string>"],"api":{"apiDefinition":{"type":"<string>","description":"<string>","title":"<string>","version":"<string>","uri":["<string>"],"serviceRegistryDisplayName":"<string>"},"nativeEndpoint":[{"optimizationTechnique":"<string>","passSecurityHeaders":"<boolean>","uri":"<string>","connectionTimeoutDuration":"<integer>","alias":"<boolean>"}],"apiName":"<string>","apiVersion":"<string>","apiEndpointPrefix":"<string>","apiDescription":"<string>","maturityState":"<string>","apiGroups":["<string>","<string>"],"isActive":"<boolean>","type":"<string>","owner":"<string>","policies":["<string>","<string>"],"rootFileName":"<string>","scopes":[{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"},{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"}],"publishedPortals":["<string>","<string>"],"publishedToRegistry":"<boolean>","creationDate":"<string>","lastModified":"<string>","prevVersion":"<string>","nextVersion":"<string>","systemVersion":"<integer>","provider":"<string>","centraSiteURL":"<string>","mockService":{"enableMock":"<boolean>","runAsUser":"<string>","service":"<string>"},"apiDocuments":["<string>","<string>"],"id":"<string>","oauth2ScopeName":"<string>"},"apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"}}}}},"deprecated":false},"parameters":[]},"/apis":{"get":{"tags":["APIs"],"summary":"Get All APIs","description":"Get all APIs or subset of APIs","operationId":"GetAllAPIs","parameters":[{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": [\\r\\n {\\r\\n \\\"api\\\": {\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"v2\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"systemVersion\\\": 2,\\r\\n \\\"id\\\": \\\"46df4227-a100-486c-9580-0bf388ec6ec7\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n },\\r\\n {\\r\\n \\\"api\\\": {\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n ]\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": [\\r\\n {\\r\\n \\\"api\\\": {\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"v2\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"systemVersion\\\": 2,\\r\\n \\\"id\\\": \\\"46df4227-a100-486c-9580-0bf388ec6ec7\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n },\\r\\n {\\r\\n \\\"api\\\": {\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n ]\\r\\n}\""}}},"401":{"description":"Unauthorized","headers":{},"content":{}}},"deprecated":false},"post":{"tags":["APIs"],"summary":"Create API","description":"This REST operation is used to create an API by importing a file, url or from scratch","operationId":"CreateAPI","parameters":[{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"const":"multipart/form-data","type":"string","examples":["multipart/form-data"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["file","apiName","type","apiDescription","apiVersion"],"type":"object","properties":{"file":{"type":"string","description":"Input swagger / raml / wsdl file to be imported"},"apiName":{"type":"string","description":"Name of the API","examples":["Doggie"]},"type":{"type":"string","description":"Input file type (This can only be one of swagger,raml,wsdl,openapi)","examples":["swagger"]},"apiDescription":{"type":"string","description":"Description of the API","examples":["description flows here"]},"apiVersion":{"type":"number","description":"Version of the API","contentEncoding":"double","examples":[1]}},"contentMediaType":"application/x-www-form-urlencoded"}}},"required":false},"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ],\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ] }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ],\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ] }\\r\\n}\""}}},"401":{"description":"Unauthorized","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}}},"deprecated":false},"put":{"tags":["APIs"],"summary":"Update API","description":"Get the API details by ID using our rest service and update the api with the needed changes.","operationId":"UpdateAPI","parameters":[{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAPIRequest"}}},"required":true},"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ],\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ] }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ],\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ] }\\r\\n}\""}}}},"deprecated":false},"delete":{"tags":["APIs"],"summary":"Delete APIs","description":"Delete the inactive APIs","operationId":"DeleteAPIs","parameters":[{"name":"apiIds","in":"query","description":"(Required) API Ids for the APIs to be deleted. Multiple API ids combined by comma","required":true,"style":"form","explode":true,"schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0,2c843837-cc6c-4ba1-aaf3-b10f8e9adbe7"]}},{"name":"forceDelete","in":"query","description":"Flag for force delete. Required when API is associated with some applications","required":true,"style":"form","explode":true,"schema":{"type":"boolean","examples":[true]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"400":{"description":"Bad Request","headers":{},"content":{}},"204":{"description":"No Content","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReturnstheapiIdalongwiththeerrorwhenunsuccessful"},"description":"","examples":[[{"id":"<string>","apiName":"<string>","apiVersion":"<string>","type":"<string>","publishedPortals":["<string>","<string>"],"systemVersion":"<integer>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"active":"<boolean>","apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"},{"id":"<string>","apiName":"<string>","apiVersion":"<string>","type":"<string>","publishedPortals":["<string>","<string>"],"systemVersion":"<integer>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"active":"<boolean>","apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"}]],"contentMediaType":"application/json"},"example":[{"id":"<string>","apiName":"<string>","apiVersion":"<string>","type":"<string>","publishedPortals":["<string>","<string>"],"systemVersion":"<integer>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"active":"<boolean>","apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"},{"id":"<string>","apiName":"<string>","apiVersion":"<string>","type":"<string>","publishedPortals":["<string>","<string>"],"systemVersion":"<integer>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"active":"<boolean>","apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"}]}}}},"deprecated":false},"parameters":[]},"/serviceRegistry/unpublish":{"put":{"tags":["Service Registry"],"summary":"Unpublish From Service Registry","description":"Unpublish one or more APIs from one or more service registries.\n\nUnpublish one or more APIs using the below payload.\n\n\n{\n\t\"unpublishInfos\": [\n\t\t{\n\t\t\t\"serviceRegistryIds\": [\n\t\t\t\t\"EurekaDefault\"\n\t\t\t],\n\t\t\t\"apiId\": \"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0\"\n\t\t},\n\t\t{\n\t\t\t\"serviceRegistryIds\": [\n\t\t\t\t\"EurekaDefault\"\n\t\t\t],\n\t\t\t\"apiId\": \"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0\"\n\t\t}\n\t]\n}","operationId":"UnpublishFromServiceRegistry","parameters":[{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UnpublishFromServiceRegistryRequest"},{"examples":[{"unpublishInfo":{"serviceRegistryIds":["EurekaDefault"],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}}]}],"contentMediaType":"application/json"},"example":{"unpublishInfo":{"serviceRegistryIds":["EurekaDefault"],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}}}},"required":true},"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"unpublishResponse\\\": {\\r\\n \\\"apiId\\\": \\\"afe8b72e-e1a5-47c6-9b43-e7f12858c091\\\",\\r\\n \\\"apiName\\\": \\\"CalcService\\\",\\r\\n \\\"apiVersion\\\": \\\"10.3\\\",\\r\\n \\\"serviceRegistryUnpublishResponses\\\": [\\r\\n {\\r\\n \\\"serviceRegistryId\\\": \\\"aec973cd-1e4c-4a93-93a4-950e32d39156\\\",\\r\\n \\\"serviceRegistryName\\\": \\\"MyServiceConsul\\\",\\r\\n \\\"success\\\": true,\\r\\n \\\"description\\\": \\\" Unpublish successful\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"unpublishResponse\\\": {\\r\\n \\\"apiId\\\": \\\"afe8b72e-e1a5-47c6-9b43-e7f12858c091\\\",\\r\\n \\\"apiName\\\": \\\"CalcService\\\",\\r\\n \\\"apiVersion\\\": \\\"10.3\\\",\\r\\n \\\"serviceRegistryUnpublishResponses\\\": [\\r\\n {\\r\\n \\\"serviceRegistryId\\\": \\\"aec973cd-1e4c-4a93-93a4-950e32d39156\\\",\\r\\n \\\"serviceRegistryName\\\": \\\"MyServiceConsul\\\",\\r\\n \\\"success\\\": true,\\r\\n \\\"description\\\": \\\" Unpublish successful\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""}}}},"deprecated":false},"parameters":[]},"/serviceRegistry/publish":{"get":{"tags":["Service Registry"],"summary":"Get Service Registry Publish Info","description":"Retrieve the service registry publish information for the API","operationId":"GetServiceRegistryPublishInfo","parameters":[{"name":"apiId","in":"query","description":"(Required) API Id of the API for which ServiceRegistryPublishInfo is to be fetched","required":true,"style":"form","explode":true,"schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"401":{"description":"Unauthorized","headers":{},"content":{}},"404":{"description":"Not Found","headers":{},"content":{}},"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"publishInfo\\\": {\\r\\n \\\"apiId\\\": \\\"afe8b72e-e1a5-47c6-9b43-e7f12858c091\\\",\\r\\n \\\"serviceRegistryPublishInfo\\\": [\\r\\n {\\r\\n \\\"serviceRegistryId\\\": \\\"aec973cd-1e4c-4a93-93a4-950e32d39156\\\",\\r\\n \\\"status\\\": \\\"PUBLISHED\\\",\\r\\n \\\"name\\\": \\\"MyServiceConsul\\\",\\r\\n \\\"gatewayEndpoints\\\": [\\r\\n {\\r\\n \\\"gatewayEndpoint\\\": \\\"http://localhost:5555/ws/calc/1\\\",\\r\\n \\\"status\\\": \\\"PUBLISHED\\\"\\r\\n },\\r\\n {\\r\\n \\\"gatewayEndpoint\\\": \\\"http://localhost:1111/ws/calc/1\\\",\\r\\n \\\"status\\\": \\\"NEW\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"publishInfo\\\": {\\r\\n \\\"apiId\\\": \\\"afe8b72e-e1a5-47c6-9b43-e7f12858c091\\\",\\r\\n \\\"serviceRegistryPublishInfo\\\": [\\r\\n {\\r\\n \\\"serviceRegistryId\\\": \\\"aec973cd-1e4c-4a93-93a4-950e32d39156\\\",\\r\\n \\\"status\\\": \\\"PUBLISHED\\\",\\r\\n \\\"name\\\": \\\"MyServiceConsul\\\",\\r\\n \\\"gatewayEndpoints\\\": [\\r\\n {\\r\\n \\\"gatewayEndpoint\\\": \\\"http://localhost:5555/ws/calc/1\\\",\\r\\n \\\"status\\\": \\\"PUBLISHED\\\"\\r\\n },\\r\\n {\\r\\n \\\"gatewayEndpoint\\\": \\\"http://localhost:1111/ws/calc/1\\\",\\r\\n \\\"status\\\": \\\"NEW\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""}}}},"deprecated":false},"put":{"tags":["Service Registry"],"summary":"Publish To Service Registry","description":"Publish one or more APIs to one or more service registries.\n\nPublish more than one APIs with the given payload\n\n{\n\t\"publishInfos\": [\n\t\t{\n\t\t\t\"serviceRegistryPublishInfo\": [\n\t\t\t\t{\n\t\t\t\t\t\"gatewayEndpoints\": [],\n\t\t\t\t\t\"serviceRegistryId\": \"EurekaDefault\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"apiId\": \"d3371bdb-457a-4248-8034-7887ac8b42de\"\n\t\t},\n\t\t{\n\t\t\t\"serviceRegistryPublishInfo\": [\n\t\t\t\t{\n\t\t\t\t\t\"gatewayEndpoints\": [],\n\t\t\t\t\t\"serviceRegistryId\": \"EurekaDefault\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"apiId\": \"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0\"\n\t\t}\n\t]\n}","operationId":"PublishToServiceRegistry","parameters":[{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PublishToServiceRegistryRequest"},{"examples":[{"publishInfo":{"serviceRegistryPublishInfo":[{"gatewayEndpoints":[{"gatewayEndpoint":"http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5"}],"serviceRegistryId":"EurekaDefault"}],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}}]}],"contentMediaType":"application/json"},"example":{"publishInfo":{"serviceRegistryPublishInfo":[{"gatewayEndpoints":[{"gatewayEndpoint":"http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5"}],"serviceRegistryId":"EurekaDefault"}],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}}}},"required":true},"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["\"{\\r\\n \\\"publishResponse\\\": {\\r\\n \\\"apiId\\\": \\\"afe8b72e-e1a5-47c6-9b43-e7f12858c091\\\",\\r\\n \\\"apiName\\\": \\\"CalcService\\\",\\r\\n \\\"apiVersion\\\": \\\"10.3\\\",\\r\\n \\\"serviceRegistryPublishResponses\\\": [\\r\\n {\\r\\n \\\"serviceRegistryId\\\": \\\"aec973cd-1e4c-4a93-93a4-950e32d39156\\\",\\r\\n \\\"serviceRegistryName\\\": \\\"MyServiceConsul\\\",\\r\\n \\\"status\\\": \\\"PUBLISHED\\\",\\r\\n \\\"gatewayEndpoints\\\": [\\r\\n {\\r\\n \\\"gatewayEndpoint\\\": \\\"http://localhost:5555/ws/calc/1\\\",\\r\\n \\\"status\\\": \\\"PUBLISHED\\\",\\r\\n }\\r\\n ],\\r\\n \\\"success\\\": true,\\r\\n \\\"description\\\": \\\"Publish successful\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""],"contentMediaType":"application/json"},"example":"\"{\\r\\n \\\"publishResponse\\\": {\\r\\n \\\"apiId\\\": \\\"afe8b72e-e1a5-47c6-9b43-e7f12858c091\\\",\\r\\n \\\"apiName\\\": \\\"CalcService\\\",\\r\\n \\\"apiVersion\\\": \\\"10.3\\\",\\r\\n \\\"serviceRegistryPublishResponses\\\": [\\r\\n {\\r\\n \\\"serviceRegistryId\\\": \\\"aec973cd-1e4c-4a93-93a4-950e32d39156\\\",\\r\\n \\\"serviceRegistryName\\\": \\\"MyServiceConsul\\\",\\r\\n \\\"status\\\": \\\"PUBLISHED\\\",\\r\\n \\\"gatewayEndpoints\\\": [\\r\\n {\\r\\n \\\"gatewayEndpoint\\\": \\\"http://localhost:5555/ws/calc/1\\\",\\r\\n \\\"status\\\": \\\"PUBLISHED\\\",\\r\\n }\\r\\n ],\\r\\n \\\"success\\\": true,\\r\\n \\\"description\\\": \\\"Publish successful\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""}}},"404":{"description":"Not Found","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}}},"deprecated":false},"parameters":[]},"/integrationServer/publish":{"get":{"tags":["Integration Server"],"summary":"Get Integration Server Publish Info","description":"Retrieve the integration server publish information for the API. Only REST and SOAP APIs are supported.","operationId":"GetIntegrationServerPublishInfo","parameters":[{"name":"apiId","in":"query","description":"(Required) API Id of the API for which IntegrationServerPublishInfo is to be fetched","required":true,"style":"form","explode":true,"schema":{"type":"string","examples":["2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"]}},{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReturnstheintegrationserverpublishinfofortheAPI"},{"examples":[{"publishInfo":{"apiId":"<string>","serviceRegistryPublishInfo":[{"serviceRegistryId":"<string>","status":"<string>","name":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}]},{"serviceRegistryId":"<string>","status":"<string>","name":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}]}],"integrationServerPublishInfo":[{"integrationServerId":"<string>","packageName":"<string>","folderName":"<string>","status":"<string>","integrationServerName":"<string>"},{"integrationServerId":"<string>","packageName":"<string>","folderName":"<string>","status":"<string>","integrationServerName":"<string>"}]}}]}],"contentMediaType":"application/json"},"example":{"publishInfo":{"apiId":"<string>","serviceRegistryPublishInfo":[{"serviceRegistryId":"<string>","status":"<string>","name":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}]},{"serviceRegistryId":"<string>","status":"<string>","name":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}]}],"integrationServerPublishInfo":[{"integrationServerId":"<string>","packageName":"<string>","folderName":"<string>","status":"<string>","integrationServerName":"<string>"},{"integrationServerId":"<string>","packageName":"<string>","folderName":"<string>","status":"<string>","integrationServerName":"<string>"}]}}}}},"404":{"description":"Not Found","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}}},"deprecated":false},"put":{"tags":["Integration Server"],"summary":"Publish To Integration Server","description":"Publish one or more APIs to one or more integration servers. Only REST and SOAP APIs are supported.\n\nPublish multiple apis to Integration Server:\n{\n\t\"publishInfos\": [\n\t\t{\n\t\t\t\"integrationServerPublishInfo\": [\n\t\t\t\t{\n\t\t\t\t\t\"packageAndFolders\": [],\n\t\t\t\t\t\"integrationServerId\": \"0ad4ee2e-956b-49e0-b7a4-a6a2ea45b034\",\n\t\t\t\t\t\"integrationServerName\": \"gora\",\n\t\t\t\t\t\"folderName\": \"test\",\n\t\t\t\t\t\"packageName\": \"test\",\n\t\t\t\t\t\"updateNativeEndpointsOfAPI\": true,\n\t\t\t\t\t\"importSwaggerBasedOnTags\": true,\n\t\t\t\t\t\"contentModelComplianceForWSDL\": \"None\",\n\t\t\t\t\t\"enableMTOM\": false,\n\t\t\t\t\t\"enforceWSICompliance\": false,\n\t\t\t\t\t\"validateSchemaWithXerces\": true\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"apiId\": \"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0\"\n\t\t},\n\t\t{\n\t\t\t\"integrationServerPublishInfo\": [\n\t\t\t\t{\n\t\t\t\t\t\"packageAndFolders\": [],\n\t\t\t\t\t\"integrationServerId\": \"0ad4ee2e-956b-49e0-b7a4-a6a2ea45b034\",\n\t\t\t\t\t\"integrationServerName\": \"gora\",\n\t\t\t\t\t\"folderName\": \"test\",\n\t\t\t\t\t\"packageName\": \"test\",\n\t\t\t\t\t\"updateNativeEndpointsOfAPI\": true,\n\t\t\t\t\t\"importSwaggerBasedOnTags\": true,\n\t\t\t\t\t\"contentModelComplianceForWSDL\": \"None\",\n\t\t\t\t\t\"enableMTOM\": false,\n\t\t\t\t\t\"enforceWSICompliance\": false,\n\t\t\t\t\t\"validateSchemaWithXerces\": true\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"apiId\": \"d3371bdb-457a-4248-8034-7887ac8b42de\"\n\t\t}\n\t]\n}","operationId":"PublishToIntegrationServer","parameters":[{"name":"Accept","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["application/json"]}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PublishToIntegrationServerRequest"},{"examples":[{"publishInfo":{"integrationServerPublishInfo":[{"packageAndFolders":[],"integrationServerId":"0ad4ee2e-956b-49e0-b7a4-a6a2ea45b034","integrationServerName":"gora","folderName":"test","packageName":"test","updateNativeEndpointsOfAPI":true,"importSwaggerBasedOnTags":true,"contentModelComplianceForWSDL":"None","enableMTOM":false,"enforceWSICompliance":false,"validateSchemaWithXerces":true}],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}}]}],"contentMediaType":"application/json"},"example":{"publishInfo":{"integrationServerPublishInfo":[{"packageAndFolders":[],"integrationServerId":"0ad4ee2e-956b-49e0-b7a4-a6a2ea45b034","integrationServerName":"gora","folderName":"test","packageName":"test","updateNativeEndpointsOfAPI":true,"importSwaggerBasedOnTags":true,"contentModelComplianceForWSDL":"None","enableMTOM":false,"enforceWSICompliance":false,"validateSchemaWithXerces":true}],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}}}},"required":true},"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Returnsthestatusofthepublishoperationsgivenintherequest."},{"examples":[{"publishResponse":{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]},"publishResponses":[{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]},{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]}]}]}],"contentMediaType":"application/json"},"example":{"publishResponse":{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]},"publishResponses":[{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]},{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]}]}}}},"404":{"description":"Not Found","headers":{},"content":{}},"401":{"description":"Unauthorized","headers":{},"content":{}},"400":{"description":"Bad Request","headers":{},"content":{}}},"deprecated":false},"parameters":[]}},"components":{"schemas":{"CreateVersionRequest":{"title":"CreateVersionRequest","required":["newApiVersion","retainApplications"],"type":"object","properties":{"newApiVersion":{"type":"string"},"retainApplications":{"type":"string"}},"examples":[{"newApiVersion":"2.0","retainApplications":"true"}]},"ReturnstheapiIdalongwiththeerrorwhenunsuccessful":{"title":"ReturnstheapiIdalongwiththeerrorwhenunsuccessful","required":["id","apiName","apiVersion","type","publishedPortals","systemVersion","teams","active","apiId","errorReason","responseStatus"],"type":"object","properties":{"id":{"type":"string"},"apiName":{"type":"string"},"apiVersion":{"type":"string"},"type":{"type":"string"},"publishedPortals":{"type":"array","items":{"type":"string"},"description":""},"systemVersion":{"type":"string"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/Team"},"description":""},"active":{"type":"string"},"apiId":{"type":"string"},"errorReason":{"type":"string"},"responseStatus":{"type":"string"}},"examples":[{"id":"<string>","apiName":"<string>","apiVersion":"<string>","type":"<string>","publishedPortals":["<string>","<string>"],"systemVersion":"<integer>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"active":"<boolean>","apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"}]},"Team":{"title":"Team","required":["id","name","source"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"source":{"type":"string"}},"examples":[{"id":"<string>","name":"<string>","source":"<string>"}]},"PublishAPIRequest":{"title":"PublishAPIRequest","required":["communities","endpoints"],"type":"object","properties":{"communities":{"type":"array","items":{"type":"string"},"description":""},"endpoints":{"type":"array","items":{"type":"string"},"description":""}},"examples":[{"communities":["3bdf8005-5685-3ef5-b132-de4681963fb6"],"endpoints":["http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5"]}]},"ReturnstheupdatedAPIobject":{"title":"ReturnstheupdatedAPIobject","required":["apiId","api","responseStatus","errorReason","gatewayEndPoints","microgatewayEndPoints","reason","pubSOAPFlavor","restrictViewAsset","rootFileLocation","teams","portalGatewayDataEntries"],"type":"object","properties":{"apiId":{"type":"string"},"api":{"$ref":"#/components/schemas/Api"},"responseStatus":{"type":"string"},"errorReason":{"type":"string"},"gatewayEndPoints":{"type":"array","items":{"type":"string"},"description":""},"microgatewayEndPoints":{"type":"array","items":{"type":"string"},"description":""},"reason":{"type":"string"},"pubSOAPFlavor":{"type":"string"},"restrictViewAsset":{"type":"string"},"rootFileLocation":{"type":"string"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/Team"},"description":""},"portalGatewayDataEntries":{"type":"string"}},"examples":[{"apiId":"<string>","api":{"apiDefinition":{"type":"<string>","description":"<string>","title":"<string>","version":"<string>","uri":["<string>"],"serviceRegistryDisplayName":"<string>"},"nativeEndpoint":[{"optimizationTechnique":"<string>","passSecurityHeaders":"<boolean>","uri":"<string>","connectionTimeoutDuration":"<integer>","alias":"<boolean>"}],"apiName":"<string>","apiVersion":"<string>","apiEndpointPrefix":"<string>","apiDescription":"<string>","maturityState":"<string>","apiGroups":["<string>","<string>"],"isActive":"<boolean>","type":"<string>","owner":"<string>","policies":["<string>","<string>"],"rootFileName":"<string>","scopes":[{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"},{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"}],"publishedPortals":["<string>","<string>"],"publishedToRegistry":"<boolean>","creationDate":"<string>","lastModified":"<string>","prevVersion":"<string>","nextVersion":"<string>","systemVersion":"<integer>","provider":"<string>","centraSiteURL":"<string>","mockService":{"enableMock":"<boolean>","runAsUser":"<string>","service":"<string>"},"apiDocuments":["<string>","<string>"],"id":"<string>","oauth2ScopeName":"<string>"},"responseStatus":"<string>","errorReason":"<string>","gatewayEndPoints":["<string>","<string>"],"microgatewayEndPoints":["<string>","<string>"],"reason":"<object>","pubSOAPFlavor":"<string>","restrictViewAsset":"<boolean>","rootFileLocation":"<string>","teams":[{"id":"<string>","name":"<string>","source":"<string>"},{"id":"<string>","name":"<string>","source":"<string>"}],"portalGatewayDataEntries":"<object>"}]},"Api":{"title":"Api","required":["apiDefinition","nativeEndpoint","apiName","apiVersion","apiEndpointPrefix","apiDescription","maturityState","apiGroups","isActive","type","owner","policies","rootFileName","scopes","publishedPortals","publishedToRegistry","creationDate","lastModified","prevVersion","nextVersion","systemVersion","provider","centraSiteURL","mockService","apiDocuments","id","oauth2ScopeName"],"type":"object","properties":{"apiDefinition":{"$ref":"#/components/schemas/ApiDefinition"},"nativeEndpoint":{"type":"array","items":{"$ref":"#/components/schemas/NativeEndpoint"},"description":""},"apiName":{"type":"string"},"apiVersion":{"type":"string"},"apiEndpointPrefix":{"type":"string"},"apiDescription":{"type":"string"},"maturityState":{"type":"string"},"apiGroups":{"type":"array","items":{"type":"string"},"description":""},"isActive":{"type":"string"},"type":{"type":"string"},"owner":{"type":"string"},"policies":{"type":"array","items":{"type":"string"},"description":""},"rootFileName":{"type":"string"},"scopes":{"type":"array","items":{"$ref":"#/components/schemas/Scope"},"description":""},"publishedPortals":{"type":"array","items":{"type":"string"},"description":""},"publishedToRegistry":{"type":"string"},"creationDate":{"type":"string"},"lastModified":{"type":"string"},"prevVersion":{"type":"string"},"nextVersion":{"type":"string"},"systemVersion":{"type":"string"},"provider":{"type":"string"},"centraSiteURL":{"type":"string"},"mockService":{"$ref":"#/components/schemas/MockService"},"apiDocuments":{"type":"array","items":{"type":"string"},"description":""},"id":{"type":"string"},"oauth2ScopeName":{"type":"string"}},"examples":[{"apiDefinition":{"type":"<string>","description":"<string>","title":"<string>","version":"<string>","uri":["<string>"],"serviceRegistryDisplayName":"<string>"},"nativeEndpoint":[{"optimizationTechnique":"<string>","passSecurityHeaders":"<boolean>","uri":"<string>","connectionTimeoutDuration":"<integer>","alias":"<boolean>"}],"apiName":"<string>","apiVersion":"<string>","apiEndpointPrefix":"<string>","apiDescription":"<string>","maturityState":"<string>","apiGroups":["<string>","<string>"],"isActive":"<boolean>","type":"<string>","owner":"<string>","policies":["<string>","<string>"],"rootFileName":"<string>","scopes":[{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"},{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"}],"publishedPortals":["<string>","<string>"],"publishedToRegistry":"<boolean>","creationDate":"<string>","lastModified":"<string>","prevVersion":"<string>","nextVersion":"<string>","systemVersion":"<integer>","provider":"<string>","centraSiteURL":"<string>","mockService":{"enableMock":"<boolean>","runAsUser":"<string>","service":"<string>"},"apiDocuments":["<string>","<string>"],"id":"<string>","oauth2ScopeName":"<string>"}]},"ApiDefinition":{"title":"ApiDefinition","required":["type","description","title","version","uri","serviceRegistryDisplayName"],"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"uri":{"type":"array","items":{"type":"string"},"description":""},"serviceRegistryDisplayName":{"type":"string"}},"examples":[{"type":"<string>","description":"<string>","title":"<string>","version":"<string>","uri":["<string>"],"serviceRegistryDisplayName":"<string>"}]},"NativeEndpoint":{"title":"NativeEndpoint","required":["optimizationTechnique","passSecurityHeaders","uri","connectionTimeoutDuration","alias"],"type":"object","properties":{"optimizationTechnique":{"type":"string"},"passSecurityHeaders":{"type":"string"},"uri":{"type":"string"},"connectionTimeoutDuration":{"type":"string"},"alias":{"type":"string"}},"examples":[{"optimizationTechnique":"<string>","passSecurityHeaders":"<boolean>","uri":"<string>","connectionTimeoutDuration":"<integer>","alias":"<boolean>"}]},"Scope":{"title":"Scope","required":["name","description","getoAuth2ScopeName","policies","mashedUpAPI"],"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"getoAuth2ScopeName":{"type":"string"},"policies":{"type":"array","items":{"type":"string"},"description":""},"mashedUpAPI":{"type":"string"}},"examples":[{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"}]},"MockService":{"title":"MockService","required":["enableMock","runAsUser","service"],"type":"object","properties":{"enableMock":{"type":"string"},"runAsUser":{"type":"string"},"service":{"type":"string"}},"examples":[{"enableMock":"<boolean>","runAsUser":"<string>","service":"<string>"}]},"Iftheformatisswaggerreturnstheswaggercontentinjson.Iftheformatiswsdlreturnsthewsdlcontentinxml.":{"title":"Iftheformatisswaggerreturnstheswaggercontentinjson.Iftheformatiswsdlreturnsthewsdlcontentinxml.","required":["versions","gatewayEndPoints","api","apiId","errorReason","responseStatus"],"type":"object","properties":{"versions":{"type":"array","items":{"$ref":"#/components/schemas/Version"},"description":""},"gatewayEndPoints":{"type":"array","items":{"type":"string"},"description":""},"api":{"$ref":"#/components/schemas/Api"},"apiId":{"type":"string"},"errorReason":{"type":"string"},"responseStatus":{"type":"string"}},"examples":[{"versions":[{"versionNumber":"<string>","apiId":"<string>"},{"versionNumber":"<string>","apiId":"<string>"}],"gatewayEndPoints":["<string>","<string>"],"api":{"apiDefinition":{"type":"<string>","description":"<string>","title":"<string>","version":"<string>","uri":["<string>"],"serviceRegistryDisplayName":"<string>"},"nativeEndpoint":[{"optimizationTechnique":"<string>","passSecurityHeaders":"<boolean>","uri":"<string>","connectionTimeoutDuration":"<integer>","alias":"<boolean>"}],"apiName":"<string>","apiVersion":"<string>","apiEndpointPrefix":"<string>","apiDescription":"<string>","maturityState":"<string>","apiGroups":["<string>","<string>"],"isActive":"<boolean>","type":"<string>","owner":"<string>","policies":["<string>","<string>"],"rootFileName":"<string>","scopes":[{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"},{"name":"<string>","description":"<string>","getoAuth2ScopeName":"<string>","policies":["<string>","<string>"],"mashedUpAPI":"<boolean>"}],"publishedPortals":["<string>","<string>"],"publishedToRegistry":"<boolean>","creationDate":"<string>","lastModified":"<string>","prevVersion":"<string>","nextVersion":"<string>","systemVersion":"<integer>","provider":"<string>","centraSiteURL":"<string>","mockService":{"enableMock":"<boolean>","runAsUser":"<string>","service":"<string>"},"apiDocuments":["<string>","<string>"],"id":"<string>","oauth2ScopeName":"<string>"},"apiId":"<string>","errorReason":"<string>","responseStatus":"<string>"}]},"Version":{"title":"Version","required":["versionNumber","apiId"],"type":"object","properties":{"versionNumber":{"type":"string"},"apiId":{"type":"string"}},"examples":[{"versionNumber":"<string>","apiId":"<string>"}]},"UpdateAPIRequest":{"title":"UpdateAPIRequest","required":["apiDefinition","nativeEndpoint","apiName","apiVersion","apiDescription","maturityState","isActive","type","owner","policies","scopes","publishedPortals","creationDate","systemVersion","id"],"type":"object","properties":{"apiDefinition":{"$ref":"#/components/schemas/ApiDefinition2"},"nativeEndpoint":{"type":"array","items":{"$ref":"#/components/schemas/NativeEndpoint2"},"description":""},"apiName":{"type":"string"},"apiVersion":{"type":"string"},"apiDescription":{"type":"string"},"maturityState":{"type":"string"},"isActive":{"type":"boolean"},"type":{"type":"string"},"owner":{"type":"string"},"policies":{"type":"array","items":{"type":"string"},"description":""},"scopes":{"type":"array","items":{"type":"string"},"description":""},"publishedPortals":{"type":"array","items":{"type":"string"},"description":""},"creationDate":{"type":"string"},"systemVersion":{"type":"integer","contentEncoding":"int32"},"id":{"type":"string"}}},"ApiDefinition2":{"title":"ApiDefinition2","required":["info","host","basePath","tags","schemes","security","paths","securityDefinitions","definitions","baseUriParameters","externalDocs","servers","components","type"],"type":"object","properties":{"info":{"$ref":"#/components/schemas/Info"},"host":{"type":"string"},"basePath":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"},"description":""},"schemes":{"type":"array","items":{"type":"string"},"description":""},"security":{"type":"array","items":{"type":"string"},"description":""},"paths":{"$ref":"#/components/schemas/Paths"},"securityDefinitions":{"$ref":"#/components/schemas/SecurityDefinitions"},"definitions":{"type":"object"},"baseUriParameters":{"type":"array","items":{"type":"string"},"description":""},"externalDocs":{"type":"array","items":{"$ref":"#/components/schemas/ExternalDocs"},"description":""},"servers":{"type":"array","items":{"$ref":"#/components/schemas/Server"},"description":""},"components":{"$ref":"#/components/schemas/Components"},"type":{"type":"string"}}},"Info":{"title":"Info","required":["description","version","title","termsOfService","contact","license"],"type":"object","properties":{"description":{"type":"string"},"version":{"type":"string"},"title":{"type":"string"},"termsOfService":{"type":"string"},"contact":{"$ref":"#/components/schemas/Contact"},"license":{"$ref":"#/components/schemas/License"}},"examples":[{"description":"description flows here","version":"1.0","title":"Swagger Petstore","termsOfService":"http://swagger.io/terms/","contact":{"email":"apiteam@swagger.io"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}}]},"Contact":{"title":"Contact","required":["email"],"type":"object","properties":{"email":{"type":"string"}},"examples":[{"email":"apiteam@swagger.io"}]},"License":{"title":"License","required":["name","url"],"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"examples":[{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}]},"Tag":{"title":"Tag","required":["name","description"],"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"}},"examples":[{"name":"pet","description":"Everything about your Pets","externalDocs":{"description":"Find out more","url":"http://swagger.io"}}]},"ExternalDocs":{"title":"ExternalDocs","required":["description","url"],"type":"object","properties":{"description":{"type":"string"},"url":{"type":"string"}},"examples":[{"description":"Find out more","url":"http://swagger.io"}]},"Paths":{"title":"Paths","required":["/pet","/pet/findByStatus","/pet/findByTags","/pet/{petId}","/pet/{petId}/uploadImage","/store/inventory","/store/order","/store/order/{orderId}","/user","/user/createWithArray","/user/createWithList","/user/login","/user/logout","/user/{username}"],"type":"object","properties":{"/pet":{"$ref":"#/components/schemas/Pet"},"/pet/findByStatus":{"$ref":"#/components/schemas/PetFindByStatus"},"/pet/findByTags":{"$ref":"#/components/schemas/PetFindByTags"},"/pet/{petId}":{"$ref":"#/components/schemas/PetPetId"},"/pet/{petId}/uploadImage":{"$ref":"#/components/schemas/PetPetIdUploadImage"},"/store/inventory":{"$ref":"#/components/schemas/StoreInventory"},"/store/order":{"$ref":"#/components/schemas/StoreOrder"},"/store/order/{orderId}":{"$ref":"#/components/schemas/StoreOrderOrderId"},"/user":{"$ref":"#/components/schemas/User"},"/user/createWithArray":{"$ref":"#/components/schemas/UserCreateWithArray"},"/user/createWithList":{"$ref":"#/components/schemas/UserCreateWithList"},"/user/login":{"$ref":"#/components/schemas/UserLogin"},"/user/logout":{"$ref":"#/components/schemas/UserLogout"},"/user/{username}":{"$ref":"#/components/schemas/UserUsername"}}},"Pet":{"title":"Pet","required":["put","post","parameters","enabled"],"type":"object","properties":{"put":{"$ref":"#/components/schemas/Put"},"post":{"$ref":"#/components/schemas/Post"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}},"examples":[{"put":{"tags":["pet"],"summary":"Update an existing pet","description":"","operationId":"updatePet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"400":{"description":"Invalid ID supplied"},"404":{"description":"Pet not found"},"405":{"description":"Validation exception"}},"security":[{"petstore_auth":["write:pets","read:pets"]}],"enabled":true,"requestBody":{"description":"Pet object that needs to be added to the store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Pet"}}},"required":true}},"post":{"tags":["pet"],"summary":"Add a new pet to the store","description":"","operationId":"addPet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"405":{"description":"Invalid input"}},"security":[{"petstore_auth":["write:pets","read:pets"]}],"enabled":true,"requestBody":{"description":"Pet object that needs to be added to the store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Pet"}}},"required":true}},"parameters":[],"enabled":true}]},"Put":{"title":"Put","required":["tags","summary","description","operationId","consumes","produces","parameters","responses","security","enabled","requestBody"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"consumes":{"type":"array","items":{"type":"string"},"description":""},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"type":"string"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m400"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/Security"},"description":""},"enabled":{"type":"boolean"},"requestBody":{"$ref":"#/components/schemas/RequestBody"}},"examples":[{"tags":["pet"],"summary":"Update an existing pet","description":"","operationId":"updatePet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"400":{"description":"Invalid ID supplied"},"404":{"description":"Pet not found"},"405":{"description":"Validation exception"}},"security":[{"petstore_auth":["write:pets","read:pets"]}],"enabled":true,"requestBody":{"description":"Pet object that needs to be added to the store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Pet"}}},"required":true}}]},"m400":{"title":"m400","required":["description"],"type":"object","properties":{"description":{"type":"string"}},"examples":[{"description":"Invalid ID supplied"}]},"Security":{"title":"Security","required":["petstore_auth"],"type":"object","properties":{"petstore_auth":{"type":"array","items":{"type":"string"},"description":""}},"examples":[{"petstore_auth":["write:pets","read:pets"]}]},"RequestBody":{"title":"RequestBody","required":["description","content","required"],"type":"object","properties":{"description":{"type":"string"},"content":{"$ref":"#/components/schemas/Content"},"required":{"type":"boolean"}},"examples":[{"description":"Pet object that needs to be added to the store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Pet"}}},"required":true}]},"Content":{"title":"Content","required":["application/json","application/xml"],"type":"object","properties":{"application/json":{"$ref":"#/components/schemas/ApplicationJson"},"application/xml":{"$ref":"#/components/schemas/ApplicationXml"}},"examples":[{"application/json":{"schema":{"$ref":"#/components/schemas/Pet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Pet"}}}]},"ApplicationJson":{"title":"ApplicationJson","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema"}},"examples":[{"schema":{"$ref":"#/components/schemas/Pet"}}]},"Schema":{"title":"Schema","required":["$ref"],"type":"object","properties":{"$ref":{"type":"string"}}},"ApplicationXml":{"title":"ApplicationXml","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema"}},"examples":[{"schema":{"$ref":"#/components/schemas/Pet"}}]},"Post":{"title":"Post","required":["tags","summary","description","operationId","consumes","produces","parameters","responses","security","enabled","requestBody"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"consumes":{"type":"array","items":{"type":"string"},"description":""},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"type":"string"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m400"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/Security"},"description":""},"enabled":{"type":"boolean"},"requestBody":{"$ref":"#/components/schemas/RequestBody"}},"examples":[{"tags":["pet"],"summary":"Add a new pet to the store","description":"","operationId":"addPet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"405":{"description":"Invalid input"}},"security":[{"petstore_auth":["write:pets","read:pets"]}],"enabled":true,"requestBody":{"description":"Pet object that needs to be added to the store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Pet"}}},"required":true}}]},"PetFindByStatus":{"title":"PetFindByStatus","required":["get","parameters","enabled"],"type":"object","properties":{"get":{"$ref":"#/components/schemas/Get"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}}},"Get":{"title":"Get","required":["tags","summary","description","operationId","produces","parameters","responses","security","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m200"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/Security"},"description":""},"enabled":{"type":"boolean"}}},"Parameter":{"title":"Parameter","required":["description","in","name","parameterSchema","required"],"type":"object","properties":{"description":{"type":"string"},"in":{"type":"string"},"name":{"type":"string"},"parameterSchema":{"$ref":"#/components/schemas/ParameterSchema"},"required":{"type":"boolean"}},"examples":[{"description":"Status values that need to be considered for filter","in":"query","name":"status","parameterSchema":{"description":"Status values that need to be considered for filter","items":{"default":"available","enum":["available","pending","sold"],"type":"string"},"readOnly":false,"type":"array"},"required":true}]},"ParameterSchema":{"title":"ParameterSchema","required":["description","items","readOnly","type"],"type":"object","properties":{"description":{"type":"string"},"items":{"$ref":"#/components/schemas/Items"},"readOnly":{"type":"boolean"},"type":{"type":"string"}},"examples":[{"description":"Status values that need to be considered for filter","items":{"default":"available","enum":["available","pending","sold"],"type":"string"},"readOnly":false,"type":"array"}]},"Items":{"title":"Items","required":["default","enum","type"],"type":"object","properties":{"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"},"description":""},"type":{"type":"string"}},"examples":[{"default":"available","enum":["available","pending","sold"],"type":"string"}]},"m200":{"title":"m200","required":["description","content"],"type":"object","properties":{"description":{"type":"string"},"content":{"$ref":"#/components/schemas/Content2"}},"examples":[{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pet"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pet"}}}}}]},"Content2":{"title":"Content2","required":["application/json","application/xml"],"type":"object","properties":{"application/json":{"$ref":"#/components/schemas/ApplicationJson2"},"application/xml":{"$ref":"#/components/schemas/ApplicationXml2"}},"examples":[{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pet"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pet"}}}}]},"ApplicationJson2":{"title":"ApplicationJson2","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema4"}},"examples":[{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pet"}}}]},"Schema4":{"title":"Schema4","required":["type","items"],"type":"object","properties":{"type":{"type":"string"},"items":{"type":"object"}},"examples":[{"type":"array","items":{"$ref":"#/components/schemas/Pet"}}]},"ApplicationXml2":{"title":"ApplicationXml2","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema4"}},"examples":[{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pet"}}}]},"PetFindByTags":{"title":"PetFindByTags","required":["get","parameters","enabled"],"type":"object","properties":{"get":{"$ref":"#/components/schemas/Get1"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}}},"Get1":{"title":"Get1","required":["tags","summary","description","operationId","produces","parameters","responses","security","deprecated","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter1"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m200"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/Security"},"description":""},"deprecated":{"type":"boolean"},"enabled":{"type":"boolean"}}},"Parameter1":{"title":"Parameter1","required":["description","in","name","parameterSchema","required"],"type":"object","properties":{"description":{"type":"string"},"in":{"type":"string"},"name":{"type":"string"},"parameterSchema":{"$ref":"#/components/schemas/ParameterSchema1"},"required":{"type":"boolean"}},"examples":[{"description":"Tags to filter by","in":"query","name":"tags","parameterSchema":{"description":"Tags to filter by","items":{"type":"string"},"readOnly":false,"type":"array"},"required":true}]},"ParameterSchema1":{"title":"ParameterSchema1","required":["description","items","readOnly","type"],"type":"object","properties":{"description":{"type":"string"},"items":{"$ref":"#/components/schemas/Items1"},"readOnly":{"type":"boolean"},"type":{"type":"string"}},"examples":[{"description":"Tags to filter by","items":{"type":"string"},"readOnly":false,"type":"array"}]},"Items1":{"title":"Items1","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"PetPetId":{"title":"PetPetId","required":["get","post","delete","parameters","enabled"],"type":"object","properties":{"get":{"$ref":"#/components/schemas/Get2"},"post":{"$ref":"#/components/schemas/Post1"},"delete":{"$ref":"#/components/schemas/Delete"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}}},"Get2":{"title":"Get2","required":["tags","summary","description","operationId","produces","parameters","responses","security","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter2"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m2002"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/Security4"},"description":""},"enabled":{"type":"boolean"}}},"Parameter2":{"title":"Parameter2","required":["description","in","name","parameterSchema","required"],"type":"object","properties":{"description":{"type":"string"},"in":{"type":"string"},"name":{"type":"string"},"parameterSchema":{"$ref":"#/components/schemas/ParameterSchema2"},"required":{"type":"boolean"}},"examples":[{"description":"ID of pet to return","in":"path","name":"petId","parameterSchema":{"description":"ID of pet to return","format":"int64","readOnly":false,"type":"integer"},"required":true}]},"ParameterSchema2":{"title":"ParameterSchema2","required":["description","format","readOnly","type"],"type":"object","properties":{"description":{"type":"string"},"format":{"type":"string"},"readOnly":{"type":"boolean"},"type":{"type":"string"}},"examples":[{"description":"ID of pet to return","format":"int64","readOnly":false,"type":"integer"}]},"m2002":{"title":"m2002","required":["description","content"],"type":"object","properties":{"description":{"type":"string"},"content":{"$ref":"#/components/schemas/Content"}},"examples":[{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Pet"}}}}]},"Security4":{"title":"Security4","required":["api_key"],"type":"object","properties":{"api_key":{"type":"array","items":{"type":"string"},"description":""}},"examples":[{"api_key":[]}]},"Post1":{"title":"Post1","required":["tags","summary","description","operationId","consumes","produces","parameters","responses","security","enabled","requestBody"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"consumes":{"type":"array","items":{"type":"string"},"description":""},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter2"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m400"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/Security"},"description":""},"enabled":{"type":"boolean"},"requestBody":{"$ref":"#/components/schemas/RequestBody2"}},"examples":[{"tags":["pet"],"summary":"Updates a pet in the store with form data","description":"","operationId":"updatePetWithForm","consumes":["application/x-www-form-urlencoded"],"produces":["application/json","application/xml"],"parameters":[{"description":"ID of pet that needs to be updated","in":"path","name":"petId","parameterSchema":{"description":"ID of pet that needs to be updated","format":"int64","readOnly":false,"type":"integer"},"required":true}],"responses":{"405":{"description":"Invalid input"}},"security":[{"petstore_auth":["write:pets","read:pets"]}],"enabled":true,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Updated name of the pet","readOnly":false},"status":{"type":"string","description":"Updated status of the pet","readOnly":false}}}}},"required":true}}]},"RequestBody2":{"title":"RequestBody2","required":["content","required"],"type":"object","properties":{"content":{"$ref":"#/components/schemas/Content5"},"required":{"type":"boolean"}},"examples":[{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Updated name of the pet","readOnly":false},"status":{"type":"string","description":"Updated status of the pet","readOnly":false}}}}},"required":true}]},"Content5":{"title":"Content5","required":["application/x-www-form-urlencoded"],"type":"object","properties":{"application/x-www-form-urlencoded":{"$ref":"#/components/schemas/ApplicationXWwwFormUrlencoded"}},"examples":[{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Updated name of the pet","readOnly":false},"status":{"type":"string","description":"Updated status of the pet","readOnly":false}}}}}]},"ApplicationXWwwFormUrlencoded":{"title":"ApplicationXWwwFormUrlencoded","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema10"}},"examples":[{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Updated name of the pet","readOnly":false},"status":{"type":"string","description":"Updated status of the pet","readOnly":false}}}}]},"Schema10":{"title":"Schema10","required":["type","properties"],"type":"object","properties":{"type":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties"}},"examples":[{"type":"object","properties":{"name":{"type":"string","description":"Updated name of the pet","readOnly":false},"status":{"type":"string","description":"Updated status of the pet","readOnly":false}}}]},"Properties":{"title":"Properties","required":["name","status"],"type":"object","properties":{"name":{"type":"object"},"status":{"type":"object"}},"examples":[{"name":{"type":"string","description":"Updated name of the pet","readOnly":false},"status":{"type":"string","description":"Updated status of the pet","readOnly":false}}]},"Delete":{"title":"Delete","required":["tags","summary","description","operationId","produces","parameters","responses","security","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter4"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m400"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/Security"},"description":""},"enabled":{"type":"boolean"}},"examples":[{"tags":["pet"],"summary":"Deletes a pet","description":"","operationId":"deletePet","produces":["application/json","application/xml"],"parameters":[{"in":"header","name":"api_key","parameterSchema":{"readOnly":false,"type":"string"},"required":false},{"description":"Pet id to delete","in":"path","name":"petId","parameterSchema":{"description":"Pet id to delete","format":"int64","readOnly":false,"type":"integer"},"required":true}],"responses":{"400":{"description":"Invalid ID supplied"},"404":{"description":"Pet not found"}},"security":[{"petstore_auth":["write:pets","read:pets"]}],"enabled":true}]},"Parameter4":{"title":"Parameter4","required":["in","name","parameterSchema","required"],"type":"object","properties":{"in":{"type":"string"},"name":{"type":"string"},"parameterSchema":{"$ref":"#/components/schemas/ParameterSchema4"},"required":{"type":"boolean"},"description":{"type":"string"}},"examples":[{"in":"header","name":"api_key","parameterSchema":{"readOnly":false,"type":"string"},"required":false}]},"ParameterSchema4":{"title":"ParameterSchema4","required":["readOnly","type"],"type":"object","properties":{"readOnly":{"type":"boolean"},"type":{"type":"string"},"description":{"type":"string"},"format":{"type":"string"}},"examples":[{"readOnly":false,"type":"string"}]},"PetPetIdUploadImage":{"title":"PetPetIdUploadImage","required":["post","parameters","enabled"],"type":"object","properties":{"post":{"$ref":"#/components/schemas/Post2"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}},"examples":[{"post":{"tags":["pet"],"summary":"uploads an image","description":"","operationId":"uploadFile","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"description":"ID of pet to update","in":"path","name":"petId","parameterSchema":{"description":"ID of pet to update","format":"int64","readOnly":false,"type":"integer"},"required":true}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse"}}}}},"security":[{"petstore_auth":["write:pets","read:pets"]}],"enabled":true,"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"additionalMetadata":{"type":"string","description":"Additional data to pass to server","readOnly":false},"file":{"type":"string","description":"file to upload","format":"binary","readOnly":false}}}}},"required":true}},"parameters":[],"enabled":true}]},"Post2":{"title":"Post2","required":["tags","summary","description","operationId","consumes","produces","parameters","responses","security","enabled","requestBody"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"consumes":{"type":"array","items":{"type":"string"},"description":""},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter2"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m2003"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/Security"},"description":""},"enabled":{"type":"boolean"},"requestBody":{"$ref":"#/components/schemas/RequestBody3"}},"examples":[{"tags":["pet"],"summary":"uploads an image","description":"","operationId":"uploadFile","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"description":"ID of pet to update","in":"path","name":"petId","parameterSchema":{"description":"ID of pet to update","format":"int64","readOnly":false,"type":"integer"},"required":true}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse"}}}}},"security":[{"petstore_auth":["write:pets","read:pets"]}],"enabled":true,"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"additionalMetadata":{"type":"string","description":"Additional data to pass to server","readOnly":false},"file":{"type":"string","description":"file to upload","format":"binary","readOnly":false}}}}},"required":true}}]},"m2003":{"title":"m2003","required":["description","content"],"type":"object","properties":{"description":{"type":"string"},"content":{"$ref":"#/components/schemas/Content6"}},"examples":[{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse"}}}}]},"Content6":{"title":"Content6","required":["application/json"],"type":"object","properties":{"application/json":{"$ref":"#/components/schemas/ApplicationJson"}},"examples":[{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse"}}}]},"RequestBody3":{"title":"RequestBody3","required":["content","required"],"type":"object","properties":{"content":{"$ref":"#/components/schemas/Content7"},"required":{"type":"boolean"}},"examples":[{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"additionalMetadata":{"type":"string","description":"Additional data to pass to server","readOnly":false},"file":{"type":"string","description":"file to upload","format":"binary","readOnly":false}}}}},"required":true}]},"Content7":{"title":"Content7","required":["multipart/form-data"],"type":"object","properties":{"multipart/form-data":{"$ref":"#/components/schemas/MultipartFormData"}},"examples":[{"multipart/form-data":{"schema":{"type":"object","properties":{"additionalMetadata":{"type":"string","description":"Additional data to pass to server","readOnly":false},"file":{"type":"string","description":"file to upload","format":"binary","readOnly":false}}}}}]},"MultipartFormData":{"title":"MultipartFormData","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema12"}},"examples":[{"schema":{"type":"object","properties":{"additionalMetadata":{"type":"string","description":"Additional data to pass to server","readOnly":false},"file":{"type":"string","description":"file to upload","format":"binary","readOnly":false}}}}]},"Schema12":{"title":"Schema12","required":["type","properties"],"type":"object","properties":{"type":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties1"}},"examples":[{"type":"object","properties":{"additionalMetadata":{"type":"string","description":"Additional data to pass to server","readOnly":false},"file":{"type":"string","description":"file to upload","format":"binary","readOnly":false}}}]},"Properties1":{"title":"Properties1","required":["additionalMetadata","file"],"type":"object","properties":{"additionalMetadata":{"type":"object"},"file":{"type":"object"}},"examples":[{"additionalMetadata":{"type":"string","description":"Additional data to pass to server","readOnly":false},"file":{"type":"string","description":"file to upload","format":"binary","readOnly":false}}]},"StoreInventory":{"title":"StoreInventory","required":["get","parameters","enabled"],"type":"object","properties":{"get":{"$ref":"#/components/schemas/Get3"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}},"examples":[{"get":{"tags":["store"],"summary":"Returns pet inventories by status","description":"Returns a map of status codes to quantities","operationId":"getInventory","produces":["application/json"],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}}},"security":[{"api_key":[]}],"enabled":true},"parameters":[],"enabled":true}]},"Get3":{"title":"Get3","required":["tags","summary","description","operationId","produces","responses","security","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m2004"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/Security4"},"description":""},"enabled":{"type":"boolean"}},"examples":[{"tags":["store"],"summary":"Returns pet inventories by status","description":"Returns a map of status codes to quantities","operationId":"getInventory","produces":["application/json"],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}}},"security":[{"api_key":[]}],"enabled":true}]},"m2004":{"title":"m2004","required":["description","content"],"type":"object","properties":{"description":{"type":"string"},"content":{"$ref":"#/components/schemas/Content8"}},"examples":[{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}}]},"Content8":{"title":"Content8","required":["application/json"],"type":"object","properties":{"application/json":{"$ref":"#/components/schemas/ApplicationJson6"}},"examples":[{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}]},"ApplicationJson6":{"title":"ApplicationJson6","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema13"}},"examples":[{"schema":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}]},"Schema13":{"title":"Schema13","required":["type","additionalProperties"],"type":"object","properties":{"type":{"type":"string"},"additionalProperties":{"type":"object"}},"examples":[{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}]},"StoreOrder":{"title":"StoreOrder","required":["post","parameters","enabled"],"type":"object","properties":{"post":{"$ref":"#/components/schemas/Post3"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}}},"Post3":{"title":"Post3","required":["tags","summary","description","operationId","consumes","produces","parameters","responses","enabled","requestBody"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"consumes":{"type":"array","items":{"type":"string"},"description":""},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"type":"string"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m2002"}},"enabled":{"type":"boolean"},"requestBody":{"$ref":"#/components/schemas/RequestBody4"}}},"RequestBody4":{"title":"RequestBody4","required":["description","content","required"],"type":"object","properties":{"description":{"type":"string"},"content":{"$ref":"#/components/schemas/Content6"},"required":{"type":"boolean"}},"examples":[{"description":"order placed for purchasing the pet","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"required":true}]},"StoreOrderOrderId":{"title":"StoreOrderOrderId","required":["get","delete","parameters","enabled"],"type":"object","properties":{"get":{"$ref":"#/components/schemas/Get4"},"delete":{"$ref":"#/components/schemas/Delete1"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}}},"Get4":{"title":"Get4","required":["tags","summary","description","operationId","produces","parameters","responses","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter6"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m2002"}},"enabled":{"type":"boolean"}}},"Parameter6":{"title":"Parameter6","required":["description","in","name","parameterSchema","required"],"type":"object","properties":{"description":{"type":"string"},"in":{"type":"string"},"name":{"type":"string"},"parameterSchema":{"$ref":"#/components/schemas/ParameterSchema6"},"required":{"type":"boolean"}},"examples":[{"description":"ID of pet that needs to be fetched","in":"path","name":"orderId","parameterSchema":{"description":"ID of pet that needs to be fetched","format":"int64","maximum":10,"minimum":1,"readOnly":false,"type":"integer"},"required":true}]},"ParameterSchema6":{"title":"ParameterSchema6","required":["description","format","maximum","minimum","readOnly","type"],"type":"object","properties":{"description":{"type":"string"},"format":{"type":"string"},"maximum":{"type":"integer","contentEncoding":"int32"},"minimum":{"type":"integer","contentEncoding":"int32"},"readOnly":{"type":"boolean"},"type":{"type":"string"}},"examples":[{"description":"ID of pet that needs to be fetched","format":"int64","maximum":10,"minimum":1,"readOnly":false,"type":"integer"}]},"Delete1":{"title":"Delete1","required":["tags","summary","description","operationId","produces","parameters","responses","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter7"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m400"}},"enabled":{"type":"boolean"}},"examples":[{"tags":["store"],"summary":"Delete purchase order by ID","description":"For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors","operationId":"deleteOrder","produces":["application/json","application/xml"],"parameters":[{"description":"ID of the order that needs to be deleted","in":"path","name":"orderId","parameterSchema":{"description":"ID of the order that needs to be deleted","format":"int64","minimum":1,"readOnly":false,"type":"integer"},"required":true}],"responses":{"400":{"description":"Invalid ID supplied"},"404":{"description":"Order not found"}},"enabled":true}]},"Parameter7":{"title":"Parameter7","required":["description","in","name","parameterSchema","required"],"type":"object","properties":{"description":{"type":"string"},"in":{"type":"string"},"name":{"type":"string"},"parameterSchema":{"$ref":"#/components/schemas/ParameterSchema7"},"required":{"type":"boolean"}},"examples":[{"description":"ID of the order that needs to be deleted","in":"path","name":"orderId","parameterSchema":{"description":"ID of the order that needs to be deleted","format":"int64","minimum":1,"readOnly":false,"type":"integer"},"required":true}]},"ParameterSchema7":{"title":"ParameterSchema7","required":["description","format","minimum","readOnly","type"],"type":"object","properties":{"description":{"type":"string"},"format":{"type":"string"},"minimum":{"type":"integer","contentEncoding":"int32"},"readOnly":{"type":"boolean"},"type":{"type":"string"}},"examples":[{"description":"ID of the order that needs to be deleted","format":"int64","minimum":1,"readOnly":false,"type":"integer"}]},"User":{"title":"User","required":["post","parameters","enabled"],"type":"object","properties":{"post":{"$ref":"#/components/schemas/Post4"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}},"examples":[{"post":{"tags":["user"],"summary":"Create user","description":"This can only be done by the logged in user.","operationId":"createUser","consumes":["application/json"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"default":{"description":"successful operation"}},"enabled":true,"requestBody":{"description":"Created user object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"required":true}},"parameters":[],"enabled":true}]},"Post4":{"title":"Post4","required":["tags","summary","description","operationId","consumes","produces","parameters","responses","enabled","requestBody"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"consumes":{"type":"array","items":{"type":"string"},"description":""},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"type":"string"},"description":""},"responses":{"$ref":"#/components/schemas/Responses"},"enabled":{"type":"boolean"},"requestBody":{"$ref":"#/components/schemas/RequestBody4"}},"examples":[{"tags":["user"],"summary":"Create user","description":"This can only be done by the logged in user.","operationId":"createUser","consumes":["application/json"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"default":{"description":"successful operation"}},"enabled":true,"requestBody":{"description":"Created user object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"required":true}}]},"Responses":{"title":"Responses","required":["default"],"type":"object","properties":{"default":{"$ref":"#/components/schemas/Default"}},"examples":[{"default":{"description":"successful operation"}}]},"Default":{"title":"Default","required":["description"],"type":"object","properties":{"description":{"type":"string"}},"examples":[{"description":"successful operation"}]},"UserCreateWithArray":{"title":"UserCreateWithArray","required":["post","parameters","enabled"],"type":"object","properties":{"post":{"$ref":"#/components/schemas/Post5"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}},"examples":[{"post":{"tags":["user"],"summary":"Creates list of users with given input array","description":"","operationId":"createUsersWithArrayInput","consumes":["application/json"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"default":{"description":"successful operation"}},"enabled":true,"requestBody":{"description":"List of user object","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"required":true}},"parameters":[],"enabled":true}]},"Post5":{"title":"Post5","required":["tags","summary","description","operationId","consumes","produces","parameters","responses","enabled","requestBody"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"consumes":{"type":"array","items":{"type":"string"},"description":""},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"type":"string"},"description":""},"responses":{"$ref":"#/components/schemas/Responses"},"enabled":{"type":"boolean"},"requestBody":{"$ref":"#/components/schemas/RequestBody6"}},"examples":[{"tags":["user"],"summary":"Creates list of users with given input array","description":"","operationId":"createUsersWithArrayInput","consumes":["application/json"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"default":{"description":"successful operation"}},"enabled":true,"requestBody":{"description":"List of user object","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"required":true}}]},"RequestBody6":{"title":"RequestBody6","required":["description","content","required"],"type":"object","properties":{"description":{"type":"string"},"content":{"$ref":"#/components/schemas/Content13"},"required":{"type":"boolean"}},"examples":[{"description":"List of user object","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"required":true}]},"Content13":{"title":"Content13","required":["application/json"],"type":"object","properties":{"application/json":{"$ref":"#/components/schemas/ApplicationJson11"}},"examples":[{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}]},"ApplicationJson11":{"title":"ApplicationJson11","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema20"}},"examples":[{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}]},"Schema20":{"title":"Schema20","required":["type","items"],"type":"object","properties":{"type":{"type":"string"},"items":{"$ref":"#/components/schemas/Items2"}},"examples":[{"type":"array","items":{"$ref":"#/components/schemas/User"}}]},"Items2":{"title":"Items2","required":["$ref"],"type":"object","properties":{"$ref":{"type":"string"}}},"UserCreateWithList":{"title":"UserCreateWithList","required":["post","parameters","enabled"],"type":"object","properties":{"post":{"$ref":"#/components/schemas/Post5"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}},"examples":[{"post":{"tags":["user"],"summary":"Creates list of users with given input array","description":"","operationId":"createUsersWithListInput","consumes":["application/json"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"default":{"description":"successful operation"}},"enabled":true,"requestBody":{"description":"List of user object","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"required":true}},"parameters":[],"enabled":true}]},"UserLogin":{"title":"UserLogin","required":["get","parameters","enabled"],"type":"object","properties":{"get":{"$ref":"#/components/schemas/Get5"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}}},"Get5":{"title":"Get5","required":["tags","summary","description","operationId","produces","parameters","responses","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter8"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m2007"}},"enabled":{"type":"boolean"}}},"Parameter8":{"title":"Parameter8","required":["description","in","name","parameterSchema","required"],"type":"object","properties":{"description":{"type":"string"},"in":{"type":"string"},"name":{"type":"string"},"parameterSchema":{"$ref":"#/components/schemas/ParameterSchema8"},"required":{"type":"boolean"}},"examples":[{"description":"The user name for login","in":"query","name":"username","parameterSchema":{"description":"The user name for login","readOnly":false,"type":"string"},"required":true}]},"ParameterSchema8":{"title":"ParameterSchema8","required":["description","readOnly","type"],"type":"object","properties":{"description":{"type":"string"},"readOnly":{"type":"boolean"},"type":{"type":"string"}},"examples":[{"description":"The user name for login","readOnly":false,"type":"string"}]},"m2007":{"title":"m2007","required":["description","headersV3","content"],"type":"object","properties":{"description":{"type":"string"},"headersV3":{"$ref":"#/components/schemas/HeadersV3"},"content":{"$ref":"#/components/schemas/Content15"}},"examples":[{"description":"successful operation","headersV3":{"X-Expires-After":{"in":"header","description":"date in UTC when token expires","required":false,"parameterSchema":{"type":"string","format":"date-time"}},"X-Rate-Limit":{"in":"header","description":"calls per hour allowed by the user","required":false,"parameterSchema":{"type":"integer","format":"int32"}}},"content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}}}}]},"HeadersV3":{"title":"HeadersV3","required":["X-Expires-After","X-Rate-Limit"],"type":"object","properties":{"X-Expires-After":{"$ref":"#/components/schemas/XExpiresAfter"},"X-Rate-Limit":{"$ref":"#/components/schemas/XRateLimit"}},"examples":[{"X-Expires-After":{"in":"header","description":"date in UTC when token expires","required":false,"parameterSchema":{"type":"string","format":"date-time"}},"X-Rate-Limit":{"in":"header","description":"calls per hour allowed by the user","required":false,"parameterSchema":{"type":"integer","format":"int32"}}}]},"XExpiresAfter":{"title":"XExpiresAfter","required":["in","description","required","parameterSchema"],"type":"object","properties":{"in":{"type":"string"},"description":{"type":"string"},"required":{"type":"boolean"},"parameterSchema":{"$ref":"#/components/schemas/ParameterSchema9"}},"examples":[{"in":"header","description":"date in UTC when token expires","required":false,"parameterSchema":{"type":"string","format":"date-time"}}]},"ParameterSchema9":{"title":"ParameterSchema9","required":["type","format"],"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"}},"examples":[{"type":"string","format":"date-time"}]},"XRateLimit":{"title":"XRateLimit","required":["in","description","required","parameterSchema"],"type":"object","properties":{"in":{"type":"string"},"description":{"type":"string"},"required":{"type":"boolean"},"parameterSchema":{"$ref":"#/components/schemas/ParameterSchema9"}},"examples":[{"in":"header","description":"calls per hour allowed by the user","required":false,"parameterSchema":{"type":"integer","format":"int32"}}]},"Content15":{"title":"Content15","required":["application/json","application/xml"],"type":"object","properties":{"application/json":{"$ref":"#/components/schemas/ApplicationJson13"},"application/xml":{"$ref":"#/components/schemas/ApplicationXml7"}},"examples":[{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}}}]},"ApplicationJson13":{"title":"ApplicationJson13","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema22"}},"examples":[{"schema":{"type":"string"}}]},"Schema22":{"title":"Schema22","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"ApplicationXml7":{"title":"ApplicationXml7","required":["schema"],"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema22"}},"examples":[{"schema":{"type":"string"}}]},"UserLogout":{"title":"UserLogout","required":["get","parameters","enabled"],"type":"object","properties":{"get":{"$ref":"#/components/schemas/Get6"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}},"examples":[{"get":{"tags":["user"],"summary":"Logs out current logged in user session","description":"","operationId":"logoutUser","produces":["application/json","application/xml"],"responses":{"default":{"description":"successful operation"}},"enabled":true},"parameters":[],"enabled":true}]},"Get6":{"title":"Get6","required":["tags","summary","description","operationId","produces","responses","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"responses":{"$ref":"#/components/schemas/Responses"},"enabled":{"type":"boolean"}},"examples":[{"tags":["user"],"summary":"Logs out current logged in user session","description":"","operationId":"logoutUser","produces":["application/json","application/xml"],"responses":{"default":{"description":"successful operation"}},"enabled":true}]},"UserUsername":{"title":"UserUsername","required":["get","put","delete","parameters","enabled"],"type":"object","properties":{"get":{"$ref":"#/components/schemas/Get7"},"put":{"$ref":"#/components/schemas/Put1"},"delete":{"$ref":"#/components/schemas/Delete2"},"parameters":{"type":"array","items":{"type":"string"},"description":""},"enabled":{"type":"boolean"}}},"Get7":{"title":"Get7","required":["tags","summary","description","operationId","produces","parameters","responses","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter8"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m2002"}},"enabled":{"type":"boolean"}}},"Put1":{"title":"Put1","required":["tags","summary","description","operationId","consumes","produces","parameters","responses","enabled","requestBody"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"consumes":{"type":"array","items":{"type":"string"},"description":""},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter8"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m400"}},"enabled":{"type":"boolean"},"requestBody":{"$ref":"#/components/schemas/RequestBody4"}},"examples":[{"tags":["user"],"summary":"Updated user","description":"This can only be done by the logged in user.","operationId":"updateUser","consumes":["application/json"],"produces":["application/json","application/xml"],"parameters":[{"description":"name that need to be updated","in":"path","name":"username","parameterSchema":{"description":"name that need to be updated","readOnly":false,"type":"string"},"required":true}],"responses":{"400":{"description":"Invalid user supplied"},"404":{"description":"User not found"}},"enabled":true,"requestBody":{"description":"Updated user object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"required":true}}]},"Delete2":{"title":"Delete2","required":["tags","summary","description","operationId","produces","parameters","responses","enabled"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":""},"summary":{"type":"string"},"description":{"type":"string"},"operationId":{"type":"string"},"produces":{"type":"array","items":{"type":"string"},"description":""},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter8"},"description":""},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/m400"}},"enabled":{"type":"boolean"}},"examples":[{"tags":["user"],"summary":"Delete user","description":"This can only be done by the logged in user.","operationId":"deleteUser","produces":["application/json","application/xml"],"parameters":[{"description":"The name that needs to be deleted","in":"path","name":"username","parameterSchema":{"description":"The name that needs to be deleted","readOnly":false,"type":"string"},"required":true}],"responses":{"400":{"description":"Invalid username supplied"},"404":{"description":"User not found"}},"enabled":true}]},"SecurityDefinitions":{"title":"SecurityDefinitions","required":["api_key","petstore_auth"],"type":"object","properties":{"api_key":{"$ref":"#/components/schemas/ApiKey"},"petstore_auth":{"$ref":"#/components/schemas/PetstoreAuth"}},"examples":[{"api_key":{"in":"header","name":"api_key","type":"apiKey"},"petstore_auth":{"authorizationUrl":"https://petstore.swagger.io/oauth/authorize","flow":"implicit","scopes":{"read:pets":"read your pets","write:pets":"modify pets in your account"},"type":"oauth2"}}]},"ApiKey":{"title":"ApiKey","required":["in","name","type"],"type":"object","properties":{"in":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"examples":[{"in":"header","name":"api_key","type":"apiKey"}]},"PetstoreAuth":{"title":"PetstoreAuth","required":["authorizationUrl","flow","scopes","type"],"type":"object","properties":{"authorizationUrl":{"type":"string"},"flow":{"type":"string"},"scopes":{"$ref":"#/components/schemas/Scopes"},"type":{"type":"string"}},"examples":[{"authorizationUrl":"https://petstore.swagger.io/oauth/authorize","flow":"implicit","scopes":{"read:pets":"read your pets","write:pets":"modify pets in your account"},"type":"oauth2"}]},"Scopes":{"title":"Scopes","required":["read:pets","write:pets"],"type":"object","properties":{"read:pets":{"type":"string"},"write:pets":{"type":"string"}},"examples":[{"read:pets":"read your pets","write:pets":"modify pets in your account"}]},"Server":{"title":"Server","required":["url"],"type":"object","properties":{"url":{"type":"string"}},"examples":[{"url":"https://petstore.swagger.io/v2"}]},"Components":{"title":"Components","required":["schemas"],"type":"object","properties":{"schemas":{"$ref":"#/components/schemas/Schemas"}},"examples":[{"schemas":{"ApiResponse":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"type":{"type":"string"}}},"Category":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"xml":{"name":"Category"}},"Order":{"type":"object","properties":{"complete":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"petId":{"type":"integer","format":"int64"},"quantity":{"type":"integer","format":"int32"},"shipDate":{"type":"string","format":"date-time"},"status":{"type":"string","description":"Order Status","enum":["placed","approved","delivered"]}},"xml":{"name":"Order"}},"Pet":{"required":["photoUrls","name"],"type":"object","properties":{"category":{"$ref":"#/components/schemas/Category"},"id":{"type":"integer","format":"int64"},"name":{"type":"string","example":"doggie"},"photoUrls":{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}},"status":{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]},"tags":{"type":"array","xml":{"wrapped":true},"items":{"$ref":"#/components/schemas/Tag","xml":{"name":"tag"}}}},"xml":{"name":"Pet"}},"Tag":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"xml":{"name":"Tag"}},"User":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer","format":"int64"},"lastName":{"type":"string"},"password":{"type":"string"},"phone":{"type":"string"},"userStatus":{"type":"integer","description":"User Status","format":"int32"},"username":{"type":"string"}},"xml":{"name":"User"}}}}]},"Schemas":{"title":"Schemas","required":["ApiResponse","Category","Order","Pet","Tag","User"],"type":"object","properties":{"ApiResponse":{"$ref":"#/components/schemas/ApiResponse"},"Category":{"$ref":"#/components/schemas/Category"},"Order":{"$ref":"#/components/schemas/Order"},"Pet":{"$ref":"#/components/schemas/Pet1"},"Tag":{"$ref":"#/components/schemas/Tag1"},"User":{"$ref":"#/components/schemas/User1"}},"examples":[{"ApiResponse":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"type":{"type":"string"}}},"Category":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"xml":{"name":"Category"}},"Order":{"type":"object","properties":{"complete":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"petId":{"type":"integer","format":"int64"},"quantity":{"type":"integer","format":"int32"},"shipDate":{"type":"string","format":"date-time"},"status":{"type":"string","description":"Order Status","enum":["placed","approved","delivered"]}},"xml":{"name":"Order"}},"Pet":{"required":["photoUrls","name"],"type":"object","properties":{"category":{"$ref":"#/components/schemas/Category"},"id":{"type":"integer","format":"int64"},"name":{"type":"string","example":"doggie"},"photoUrls":{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}},"status":{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]},"tags":{"type":"array","xml":{"wrapped":true},"items":{"$ref":"#/components/schemas/Tag","xml":{"name":"tag"}}}},"xml":{"name":"Pet"}},"Tag":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"xml":{"name":"Tag"}},"User":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer","format":"int64"},"lastName":{"type":"string"},"password":{"type":"string"},"phone":{"type":"string"},"userStatus":{"type":"integer","description":"User Status","format":"int32"},"username":{"type":"string"}},"xml":{"name":"User"}}}]},"ApiResponse":{"title":"ApiResponse","required":["type","properties"],"type":"object","properties":{"type":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties2"}},"examples":[{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"type":{"type":"string"}}}]},"Properties2":{"title":"Properties2","required":["code","message","type"],"type":"object","properties":{"code":{"$ref":"#/components/schemas/Code"},"message":{"$ref":"#/components/schemas/Message"},"type":{"$ref":"#/components/schemas/Type"}},"examples":[{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"type":{"type":"string"}}]},"Code":{"title":"Code","required":["type","format"],"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"}},"examples":[{"type":"integer","format":"int32"}]},"Message":{"title":"Message","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"Type":{"title":"Type","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"Category":{"title":"Category","required":["type","properties","xml"],"type":"object","properties":{"type":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties3"},"xml":{"$ref":"#/components/schemas/Xml"}},"examples":[{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"xml":{"name":"Category"}}]},"Properties3":{"title":"Properties3","required":["id","name"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"name":{"$ref":"#/components/schemas/Name"}},"examples":[{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}]},"Id":{"title":"Id","required":["type","format"],"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"}},"examples":[{"type":"integer","format":"int64"}]},"Name":{"title":"Name","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"Xml":{"title":"Xml","required":["name"],"type":"object","properties":{"name":{"type":"string"}},"examples":[{"name":"Category"}]},"Order":{"title":"Order","required":["type","properties","xml"],"type":"object","properties":{"type":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties4"},"xml":{"$ref":"#/components/schemas/Xml"}},"examples":[{"type":"object","properties":{"complete":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"petId":{"type":"integer","format":"int64"},"quantity":{"type":"integer","format":"int32"},"shipDate":{"type":"string","format":"date-time"},"status":{"type":"string","description":"Order Status","enum":["placed","approved","delivered"]}},"xml":{"name":"Order"}}]},"Properties4":{"title":"Properties4","required":["complete","id","petId","quantity","shipDate","status"],"type":"object","properties":{"complete":{"$ref":"#/components/schemas/Complete"},"id":{"$ref":"#/components/schemas/Id"},"petId":{"$ref":"#/components/schemas/PetId"},"quantity":{"$ref":"#/components/schemas/Quantity"},"shipDate":{"$ref":"#/components/schemas/ShipDate"},"status":{"$ref":"#/components/schemas/Status"}},"examples":[{"complete":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"petId":{"type":"integer","format":"int64"},"quantity":{"type":"integer","format":"int32"},"shipDate":{"type":"string","format":"date-time"},"status":{"type":"string","description":"Order Status","enum":["placed","approved","delivered"]}}]},"Complete":{"title":"Complete","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"boolean"}]},"PetId":{"title":"PetId","required":["type","format"],"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"}},"examples":[{"type":"integer","format":"int64"}]},"Quantity":{"title":"Quantity","required":["type","format"],"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"}},"examples":[{"type":"integer","format":"int32"}]},"ShipDate":{"title":"ShipDate","required":["type","format"],"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"}},"examples":[{"type":"string","format":"date-time"}]},"Status":{"title":"Status","required":["type","description","enum"],"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"enum":{"type":"array","items":{"type":"string"},"description":""}},"examples":[{"type":"string","description":"Order Status","enum":["placed","approved","delivered"]}]},"Pet1":{"title":"Pet1","required":["required","type","properties","xml"],"type":"object","properties":{"required":{"type":"array","items":{"type":"string"},"description":""},"type":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties5"},"xml":{"$ref":"#/components/schemas/Xml"}},"examples":[{"required":["photoUrls","name"],"type":"object","properties":{"category":{"$ref":"#/components/schemas/Category"},"id":{"type":"integer","format":"int64"},"name":{"type":"string","example":"doggie"},"photoUrls":{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}},"status":{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]},"tags":{"type":"array","xml":{"wrapped":true},"items":{"$ref":"#/components/schemas/Tag","xml":{"name":"tag"}}}},"xml":{"name":"Pet"}}]},"Properties5":{"title":"Properties5","required":["category","id","name","photoUrls","status","tags"],"type":"object","properties":{"category":{"$ref":"#/components/schemas/Category1"},"id":{"$ref":"#/components/schemas/Id"},"name":{"$ref":"#/components/schemas/Name1"},"photoUrls":{"$ref":"#/components/schemas/PhotoUrls"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"$ref":"#/components/schemas/Tags"}},"examples":[{"category":{"$ref":"#/components/schemas/Category"},"id":{"type":"integer","format":"int64"},"name":{"type":"string","example":"doggie"},"photoUrls":{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}},"status":{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]},"tags":{"type":"array","xml":{"wrapped":true},"items":{"$ref":"#/components/schemas/Tag","xml":{"name":"tag"}}}}]},"Category1":{"title":"Category1","required":["$ref"],"type":"object","properties":{"$ref":{"type":"string"}}},"Name1":{"title":"Name1","required":["type","example"],"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}},"examples":[{"type":"string","example":"doggie"}]},"PhotoUrls":{"title":"PhotoUrls","required":["type","xml","items"],"type":"object","properties":{"type":{"type":"string"},"xml":{"$ref":"#/components/schemas/Xml2"},"items":{"$ref":"#/components/schemas/Items4"}},"examples":[{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}]},"Xml2":{"title":"Xml2","required":["wrapped"],"type":"object","properties":{"wrapped":{"type":"boolean"}},"examples":[{"wrapped":true}]},"Items4":{"title":"Items4","required":["type","xml"],"type":"object","properties":{"type":{"type":"string"},"xml":{"$ref":"#/components/schemas/Xml"}},"examples":[{"type":"string","xml":{"name":"photoUrl"}}]},"Tags":{"title":"Tags","required":["type","xml","items"],"type":"object","properties":{"type":{"type":"string"},"xml":{"$ref":"#/components/schemas/Xml2"},"items":{"$ref":"#/components/schemas/Items5"}},"examples":[{"type":"array","xml":{"wrapped":true},"items":{"$ref":"#/components/schemas/Tag","xml":{"name":"tag"}}}]},"Items5":{"title":"Items5","required":["$ref","xml"],"type":"object","properties":{"$ref":{"type":"string"},"xml":{"$ref":"#/components/schemas/Xml"}}},"Tag1":{"title":"Tag1","required":["type","properties","xml"],"type":"object","properties":{"type":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties3"},"xml":{"$ref":"#/components/schemas/Xml"}},"examples":[{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"xml":{"name":"Tag"}}]},"User1":{"title":"User1","required":["type","properties","xml"],"type":"object","properties":{"type":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties7"},"xml":{"$ref":"#/components/schemas/Xml"}},"examples":[{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer","format":"int64"},"lastName":{"type":"string"},"password":{"type":"string"},"phone":{"type":"string"},"userStatus":{"type":"integer","description":"User Status","format":"int32"},"username":{"type":"string"}},"xml":{"name":"User"}}]},"Properties7":{"title":"Properties7","required":["email","firstName","id","lastName","password","phone","userStatus","username"],"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"},"firstName":{"$ref":"#/components/schemas/FirstName"},"id":{"$ref":"#/components/schemas/Id"},"lastName":{"$ref":"#/components/schemas/LastName"},"password":{"$ref":"#/components/schemas/Password"},"phone":{"$ref":"#/components/schemas/Phone"},"userStatus":{"$ref":"#/components/schemas/UserStatus"},"username":{"$ref":"#/components/schemas/Username"}},"examples":[{"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer","format":"int64"},"lastName":{"type":"string"},"password":{"type":"string"},"phone":{"type":"string"},"userStatus":{"type":"integer","description":"User Status","format":"int32"},"username":{"type":"string"}}]},"Email":{"title":"Email","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"FirstName":{"title":"FirstName","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"LastName":{"title":"LastName","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"Password":{"title":"Password","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"Phone":{"title":"Phone","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"UserStatus":{"title":"UserStatus","required":["type","description","format"],"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"format":{"type":"string"}},"examples":[{"type":"integer","description":"User Status","format":"int32"}]},"Username":{"title":"Username","required":["type"],"type":"object","properties":{"type":{"type":"string"}},"examples":[{"type":"string"}]},"NativeEndpoint2":{"title":"NativeEndpoint2","required":["passSecurityHeaders","uri","connectionTimeoutDuration","alias"],"type":"object","properties":{"passSecurityHeaders":{"type":"boolean"},"uri":{"type":"string"},"connectionTimeoutDuration":{"type":"integer","contentEncoding":"int32"},"alias":{"type":"boolean"}},"examples":[{"passSecurityHeaders":true,"uri":"http://petstore.swagger.io/v2","connectionTimeoutDuration":0,"alias":false}]},"UnpublishFromServiceRegistryRequest":{"title":"UnpublishFromServiceRegistryRequest","required":["unpublishInfo"],"type":"object","properties":{"unpublishInfo":{"$ref":"#/components/schemas/UnpublishInfo"}},"examples":[{"unpublishInfo":{"serviceRegistryIds":["EurekaDefault"],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}}]},"UnpublishInfo":{"title":"UnpublishInfo","required":["serviceRegistryIds","apiId"],"type":"object","properties":{"serviceRegistryIds":{"type":"array","items":{"type":"string"},"description":""},"apiId":{"type":"string"}},"examples":[{"serviceRegistryIds":["EurekaDefault"],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}]},"PublishToServiceRegistryRequest":{"title":"PublishToServiceRegistryRequest","required":["publishInfo"],"type":"object","properties":{"publishInfo":{"$ref":"#/components/schemas/PublishInfo"}},"examples":[{"publishInfo":{"serviceRegistryPublishInfo":[{"gatewayEndpoints":[{"gatewayEndpoint":"http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5"}],"serviceRegistryId":"EurekaDefault"}],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}}]},"PublishInfo":{"title":"PublishInfo","required":["serviceRegistryPublishInfo","apiId"],"type":"object","properties":{"serviceRegistryPublishInfo":{"type":"array","items":{"$ref":"#/components/schemas/ServiceRegistryPublishInfo"},"description":""},"apiId":{"type":"string"}},"examples":[{"serviceRegistryPublishInfo":[{"gatewayEndpoints":[{"gatewayEndpoint":"http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5"}],"serviceRegistryId":"EurekaDefault"}],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}]},"ServiceRegistryPublishInfo":{"title":"ServiceRegistryPublishInfo","required":["gatewayEndpoints","serviceRegistryId"],"type":"object","properties":{"gatewayEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/GatewayEndpoint"},"description":""},"serviceRegistryId":{"type":"string"}},"examples":[{"gatewayEndpoints":[{"gatewayEndpoint":"http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5"}],"serviceRegistryId":"EurekaDefault"}]},"GatewayEndpoint":{"title":"GatewayEndpoint","required":["gatewayEndpoint"],"type":"object","properties":{"gatewayEndpoint":{"type":"string"}},"examples":[{"gatewayEndpoint":"http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5"}]},"ReturnstheintegrationserverpublishinfofortheAPI":{"title":"ReturnstheintegrationserverpublishinfofortheAPI","required":["publishInfo"],"type":"object","properties":{"publishInfo":{"$ref":"#/components/schemas/PublishInfo1"}},"examples":[{"publishInfo":{"apiId":"<string>","serviceRegistryPublishInfo":[{"serviceRegistryId":"<string>","status":"<string>","name":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}]},{"serviceRegistryId":"<string>","status":"<string>","name":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}]}],"integrationServerPublishInfo":[{"integrationServerId":"<string>","packageName":"<string>","folderName":"<string>","status":"<string>","integrationServerName":"<string>"},{"integrationServerId":"<string>","packageName":"<string>","folderName":"<string>","status":"<string>","integrationServerName":"<string>"}]}}]},"PublishInfo1":{"title":"PublishInfo1","required":["apiId","serviceRegistryPublishInfo","integrationServerPublishInfo"],"type":"object","properties":{"apiId":{"type":"string"},"serviceRegistryPublishInfo":{"type":"array","items":{"$ref":"#/components/schemas/ServiceRegistryPublishInfo1"},"description":""},"integrationServerPublishInfo":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationServerPublishInfo"},"description":""}},"examples":[{"apiId":"<string>","serviceRegistryPublishInfo":[{"serviceRegistryId":"<string>","status":"<string>","name":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}]},{"serviceRegistryId":"<string>","status":"<string>","name":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}]}],"integrationServerPublishInfo":[{"integrationServerId":"<string>","packageName":"<string>","folderName":"<string>","status":"<string>","integrationServerName":"<string>"},{"integrationServerId":"<string>","packageName":"<string>","folderName":"<string>","status":"<string>","integrationServerName":"<string>"}]}]},"ServiceRegistryPublishInfo1":{"title":"ServiceRegistryPublishInfo1","required":["serviceRegistryId","status","name","gatewayEndpoints"],"type":"object","properties":{"serviceRegistryId":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"gatewayEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/GatewayEndpoint1"},"description":""}},"examples":[{"serviceRegistryId":"<string>","status":"<string>","name":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}]}]},"GatewayEndpoint1":{"title":"GatewayEndpoint1","required":["gatewayEndpoint","status"],"type":"object","properties":{"gatewayEndpoint":{"type":"string"},"status":{"type":"string"}},"examples":[{"gatewayEndpoint":"<string>","status":"<string>"}]},"IntegrationServerPublishInfo":{"title":"IntegrationServerPublishInfo","required":["integrationServerId","packageName","folderName","status","integrationServerName"],"type":"object","properties":{"integrationServerId":{"type":"string"},"packageName":{"type":"string"},"folderName":{"type":"string"},"status":{"type":"string"},"integrationServerName":{"type":"string"}},"examples":[{"integrationServerId":"<string>","packageName":"<string>","folderName":"<string>","status":"<string>","integrationServerName":"<string>"}]},"PublishToIntegrationServerRequest":{"title":"PublishToIntegrationServerRequest","required":["publishInfo"],"type":"object","properties":{"publishInfo":{"$ref":"#/components/schemas/PublishInfo2"}},"examples":[{"publishInfo":{"integrationServerPublishInfo":[{"packageAndFolders":[],"integrationServerId":"0ad4ee2e-956b-49e0-b7a4-a6a2ea45b034","integrationServerName":"gora","folderName":"test","packageName":"test","updateNativeEndpointsOfAPI":true,"importSwaggerBasedOnTags":true,"contentModelComplianceForWSDL":"None","enableMTOM":false,"enforceWSICompliance":false,"validateSchemaWithXerces":true}],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}}]},"PublishInfo2":{"title":"PublishInfo2","required":["integrationServerPublishInfo","apiId"],"type":"object","properties":{"integrationServerPublishInfo":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationServerPublishInfo1"},"description":""},"apiId":{"type":"string"}},"examples":[{"integrationServerPublishInfo":[{"packageAndFolders":[],"integrationServerId":"0ad4ee2e-956b-49e0-b7a4-a6a2ea45b034","integrationServerName":"gora","folderName":"test","packageName":"test","updateNativeEndpointsOfAPI":true,"importSwaggerBasedOnTags":true,"contentModelComplianceForWSDL":"None","enableMTOM":false,"enforceWSICompliance":false,"validateSchemaWithXerces":true}],"apiId":"2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0"}]},"IntegrationServerPublishInfo1":{"title":"IntegrationServerPublishInfo1","required":["packageAndFolders","integrationServerId","integrationServerName","folderName","packageName","updateNativeEndpointsOfAPI","importSwaggerBasedOnTags","contentModelComplianceForWSDL","enableMTOM","enforceWSICompliance","validateSchemaWithXerces"],"type":"object","properties":{"packageAndFolders":{"type":"array","items":{"type":"string"},"description":""},"integrationServerId":{"type":"string"},"integrationServerName":{"type":"string"},"folderName":{"type":"string"},"packageName":{"type":"string"},"updateNativeEndpointsOfAPI":{"type":"boolean"},"importSwaggerBasedOnTags":{"type":"boolean"},"contentModelComplianceForWSDL":{"type":"string"},"enableMTOM":{"type":"boolean"},"enforceWSICompliance":{"type":"boolean"},"validateSchemaWithXerces":{"type":"boolean"}},"examples":[{"packageAndFolders":[],"integrationServerId":"0ad4ee2e-956b-49e0-b7a4-a6a2ea45b034","integrationServerName":"gora","folderName":"test","packageName":"test","updateNativeEndpointsOfAPI":true,"importSwaggerBasedOnTags":true,"contentModelComplianceForWSDL":"None","enableMTOM":false,"enforceWSICompliance":false,"validateSchemaWithXerces":true}]},"Returnsthestatusofthepublishoperationsgivenintherequest.":{"title":"Returnsthestatusofthepublishoperationsgivenintherequest.","required":["publishResponse","publishResponses"],"type":"object","properties":{"publishResponse":{"$ref":"#/components/schemas/PublishResponse"},"publishResponses":{"type":"array","items":{"$ref":"#/components/schemas/PublishResponse"},"description":""}},"examples":[{"publishResponse":{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]},"publishResponses":[{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]},{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]}]}]},"PublishResponse":{"title":"PublishResponse","required":["apiId","apiName","apiVersion","serviceRegistryPublishResponses","integrationServerPublishResponses"],"type":"object","properties":{"apiId":{"type":"string"},"apiName":{"type":"string"},"apiVersion":{"type":"string"},"serviceRegistryPublishResponses":{"type":"array","items":{"$ref":"#/components/schemas/ServiceRegistryPublishResponse"},"description":""},"integrationServerPublishResponses":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationServerPublishResponse"},"description":""}},"examples":[{"apiId":"<string>","apiName":"<string>","apiVersion":"<string>","serviceRegistryPublishResponses":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"},{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}],"integrationServerPublishResponses":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"},{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]}]},"ServiceRegistryPublishResponse":{"title":"ServiceRegistryPublishResponse","required":["serviceRegistryId","serviceRegistryName","status","gatewayEndpoints","success","description","failureReason"],"type":"object","properties":{"serviceRegistryId":{"type":"string"},"serviceRegistryName":{"type":"string"},"status":{"type":"string"},"gatewayEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/GatewayEndpoint1"},"description":""},"success":{"type":"string"},"description":{"type":"string"},"failureReason":{"type":"string"}},"examples":[{"serviceRegistryId":"<string>","serviceRegistryName":"<string>","status":"<string>","gatewayEndpoints":[{"gatewayEndpoint":"<string>","status":"<string>"}],"success":"<boolean>","description":"<string>","failureReason":"<string>"}]},"IntegrationServerPublishResponse":{"title":"IntegrationServerPublishResponse","required":["integrationServerId","integrationServerName","status","success","description","failureReason"],"type":"object","properties":{"integrationServerId":{"type":"string"},"integrationServerName":{"type":"string"},"status":{"type":"string"},"success":{"type":"string"},"description":{"type":"string"},"failureReason":{"type":"string"}},"examples":[{"integrationServerId":"<string>","integrationServerName":"<string>","status":"<string>","success":"<boolean>","description":"<string>","failureReason":"<string>"}]}},"securitySchemes":{"basic":{"type":"http","scheme":"basic"}}},"security":[{"basic":[]}],"tags":[{"name":"Versions"},{"name":"Mocking"},{"name":"Scopes"},{"name":"APIs"},{"name":"Service Registry"},{"name":"Integration Server"}]}
/ apis / {apiId} / versions
/ apis / {apiId} / mock / enable
/ apis / {apiId} / mock / disable
/ apis / {apiId} / scopes
/ apis / {apiId} / scopes / {scopeName}
/ apis / {apiId}
/ apis / {apiId} / activate
/ apis / {apiId} / deactivate
/ apis / {apiId} / publish
/ apis / {apiId} / unpublish
/ apis / {apiId} / implementation
/ apis / {apiId} / applications
/ apis / {apiId} / source
/ apis / {apiId} / globalPolicies
/ apis / {apiId} / providerspecification
/ apis
/ serviceRegistry / unpublish
/ serviceRegistry / publish
/ integrationServer / publish
No API Resources

(Product) (Docs)

{"class":["gateway"],"properties":{"name":"Zuplo API Management","provider":"Zuplo, Inc","slug":"zuplo","rating":2,"license":"Proprietary","status":"Pending Review","researchDate":"2022-10","description":"Zuplo is a fresh take on the traditional API Management/Gateway platform: designed for developers and made for the edge, Zuplo offers effortless programmability and GitOps integration. Merge a PR to deploy to the edge at over 200 data-centers worldwide in <20s. Deep integration with OpenAPI including linting, automated testing and more. \n","platformCapabilities":["Gateway","Design","Portal","Monitoring","Threat Protection","Analytics","Documentation"],"gatewayCapabilities":["Custom Code Execution","OpenAPI Linting","OpenAPI Enforcement","Mediation","Traffic Management","OpenAPI Integration","Versioning","Mocking"],"customCodeSupport":["TypeScript","JavaScript"],"upstreamProtocols":["HTTP/1.1","HTTP/2.0"],"downstreamProtocols":["HTTP/1.1","HTTP/2.0"],"deliveryModels":["SaaS","Customer Managed (Cloud)","Customer Managed (On-Premises)","Hybrid"],"policies":[{"category":"Security","capabilities":["API Key Authentication","IP Access Rules","JWT authorizers (Custom, Auth0, AWS Cognito","Basic Authentication","AWS IAM roles and policies","CORS","WAF","ACL (Access Control List)","Audit Logs"]},{"category":"Traffic Management","capabilities":["Cache Lookup","Cache Invalidation","Cache Eviction","Rate Limiting (Dynamic)"]},{"category":"Mediation","capabilities":["Request Transformation","Response Transformation","OpenAPI Validation","URL Rewriting","JSON Validation","Request Size Limit","Request Termination"]},{"category":"Extensions","capabilities":["AWS Lambda integration","GitHub GitOps integration","BitBucket GitOps integration","GitLab GitOps integration"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://zuplo.com"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://zuplo.com/docs"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/zuplo.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/zuplo.png"}]}

Zuplo API Management

Zuplo is a fresh take on the traditional API Management/Gateway platform: designed for developers and made for the edge, Zuplo offers effortless programmability and GitOps integration. Merge a PR to deploy to the edge at over 200 data-centers worldwide in <20s. Deep integration with OpenAPI including linting, automated testing and more.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

Gateway
Design
Portal
Monitoring
Threat Protection
Analytics
Documentation

Gateway Capabilities

These are the capabilities the gateway supports.

Custom Code Execution
OpenAPI Linting
OpenAPI Enforcement
Mediation
Traffic Management
OpenAPI Integration
Versioning
Mocking

Upstream Protocols

The different protocols they support upstream.

HTTP/1.1
HTTP/2.0

Downtream Protocols

The different protocols they support downstream.

HTTP/1.1
HTTP/2.0

Custom Code

If they offer plugin, extension, and custom coding options.

TypeScript
JavaScript

Delivery Models

These are they ways you can deliver this solution.

SaaS
Customer Managed (Cloud)
Customer Managed (On-Premises)
Hybrid

Policies

These are the policies available across the gateway capabilities.

Security

API Key Authentication
IP Access Rules
JWT authorizers (Custom, Auth0, AWS Cognito
Basic Authentication
AWS IAM roles and policies
CORS
WAF
ACL (Access Control List)
Audit Logs

Traffic Management

Cache Lookup
Cache Invalidation
Cache Eviction
Rate Limiting (Dynamic)

Mediation

Request Transformation
Response Transformation
OpenAPI Validation
URL Rewriting
JSON Validation
Request Size Limit
Request Termination

Extensions

AWS Lambda integration
GitHub GitOps integration
BitBucket GitOps integration
GitLab GitOps integration

API Resources

No API Resources

(Product) (Docs)