openapi: 3.2.0 info: title: Ibm Api Connect Organization Resources API version: 2.0.0 contact: name: IBM url: https://www.ibm.com email: help@ibm.com license: name: tbd url: https://tbd.com termsOfService: https://www.ibm.com/legal x-refined-note: - x-ibm-name differs across the merged source definitions and was not carried description: 'Operations tagged Organization Resources across 3 of this provider''s published API definitions: ibm-api-connect-cloud-management-api-openapi.yml, ibm-api-connect-consumer-api-openapi.yml, ibm-api-connect-management-api-openapi.yml. Each path carries the servers of the definition it was published in.' tags: - name: Organization Resources paths: /orgs/{org}/availability-zones: description: The collection of Availability Zone operations parameters: - $ref: '#/components/parameters/org' post: summary: Create a Availability Zone object description: 'Create a Availability Zone object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: availability_zone_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/AvailabilityZone' examples: AvailabilityZone: summary: Example availability zone creation. value: name: acme-zone title: acme zone summary: An example availability zone application/yaml: schema: $ref: '#/components/schemas/AvailabilityZone' examples: AvailabilityZone: summary: Example availability zone creation. value: name: acme-zone title: acme zone summary: An example availability zone responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/AvailabilityZone' application/yaml: schema: $ref: '#/components/schemas/AvailabilityZone' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Availability Zone objects operationId: availability_zone_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AvailabilityZoneList' application/yaml: schema: $ref: '#/components/schemas/AvailabilityZoneList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Availability Zone objects operationId: availability_zone_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}: description: Availability Zone object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' get: summary: Get the Availability Zone object by name or id operationId: availability_zone_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AvailabilityZone' application/yaml: schema: $ref: '#/components/schemas/AvailabilityZone' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Availability Zone object by name or id description: 'Update the Availability Zone object by name or id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: availability_zone_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/AvailabilityZone' examples: AvailabilityZone: summary: Example availability zone update. value: title: acme zone update summary: An example availability zone application/yaml: schema: $ref: '#/components/schemas/AvailabilityZone' examples: AvailabilityZone: summary: Example availability zone update. value: title: acme zone update summary: An example availability zone responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AvailabilityZone' application/yaml: schema: $ref: '#/components/schemas/AvailabilityZone' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Availability Zone object by name or id operationId: availability_zone_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/AvailabilityZone' application/yaml: schema: $ref: '#/components/schemas/AvailabilityZone' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services: description: The collection of Gateway Service operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' post: summary: Create a Gateway Service object description: 'Create a Gateway Service object Required fields: - endpoint - api_endpoint_base - sni Fields not allowed: - owned - service_supported_features Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - availability_zone_url' operationId: gateway_service_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/GatewayService' examples: apiGateway: summary: Example API Gateway service with LDAP connection pool enabled. value: name: acme-api-gateway-service title: ACME API Gateway Service sni: - host: '*' tls_server_profile_url: https://acme-apim.example.com/api/orgs/tls-server-profiles endpoint: https://gw.acme-apim.example.com api_endpoint_base: https://gw.acme-apim.example.com gateway_service_type: datapower-api-gateway ldap_cxn_pool: enabled: true idle_timeout: 100 max_pool_size: 30 document_cache_size: 0 v5Gateway: summary: Example v5 Gateway service with communication of analytics set to internal service and communcation to jwt set to true. value: name: acme-v5-gateway-service title: ACME v5 Gateway Service sni: - host: '*' tls_server_profile_url: https://acme-apim.example.com/api/orgs/tls-server-profiles endpoint: https://gw.acme-apim.example.com api_endpoint_base: https://gw.acme-apim.example.com gateway_service_type: datapower-gateway communication_kind: external communication_to_analytics_with_jwt: true application/yaml: schema: $ref: '#/components/schemas/GatewayService' examples: apiGateway: summary: Example API Gateway service with LDAP connection pool enabled. value: name: acme-api-gateway-service title: ACME API Gateway Service sni: - host: '*' tls_server_profile_url: https://acme-apim.example.com/api/orgs/tls-server-profiles endpoint: https://gw.acme-apim.example.com api_endpoint_base: https://gw.acme-apim.example.com gateway_service_type: datapower-api-gateway ldap_cxn_pool: enabled: true idle_timeout: 100 max_pool_size: 30 document_cache_size: 0 v5Gateway: summary: Example v5 Gateway service with communication of analytics set to internal service and communcation to jwt set to true. value: name: acme-v5-gateway-service title: ACME v5 Gateway Service sni: - host: '*' tls_server_profile_url: https://acme-apim.example.com/api/orgs/tls-server-profiles endpoint: https://gw.acme-apim.example.com api_endpoint_base: https://gw.acme-apim.example.com gateway_service_type: datapower-gateway communication_kind: external communication_to_analytics_with_jwt: true responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/GatewayService' application/yaml: schema: $ref: '#/components/schemas/GatewayService' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Gateway Service objects operationId: gateway_service_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayServiceList' application/yaml: schema: $ref: '#/components/schemas/GatewayServiceList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Gateway Service objects operationId: gateway_service_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' - $ref: '#/components/parameters/force' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}: description: Gateway Service object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' get: summary: Get the Gateway Service object by name or id operationId: gateway_service_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayService' application/yaml: schema: $ref: '#/components/schemas/GatewayService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Gateway Service object by name or id description: 'Update the Gateway Service object by name or id Fields not allowed to be null: - endpoint - api_endpoint_base - sni Fields not allowed: - owned - endpoint - integration_url - gateway_service_type - api_endpoint_base - service_supported_features Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - availability_zone_url' operationId: gateway_service_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/GatewayService' examples: GatewayService: summary: Example of fields which can be updated on a gateway service with LDAP connection pool enabled. value: title: ACME Updated Gateway Service summary: An example gateway service sni: - host: '*' tls_server_profile_url: https://acme-apim.example.com/api/orgs/tls-server-profiles endpoint: https://gw.acme-apim.example.com api_endpoint_base: https://gw.acme-apim.example.com gateway_service_type: datapower-api-gateway ldap_cxn_pool: enabled: true idle_timeout: 120 max_pool_size: 35 document_cache_size: 0 communication_to_analytics_with_jwt: true application/yaml: schema: $ref: '#/components/schemas/GatewayService' examples: GatewayService: summary: Example of fields which can be updated on a gateway service with LDAP connection pool enabled. value: title: ACME Updated Gateway Service summary: An example gateway service sni: - host: '*' tls_server_profile_url: https://acme-apim.example.com/api/orgs/tls-server-profiles endpoint: https://gw.acme-apim.example.com api_endpoint_base: https://gw.acme-apim.example.com gateway_service_type: datapower-api-gateway ldap_cxn_pool: enabled: true idle_timeout: 120 max_pool_size: 35 document_cache_size: 0 communication_to_analytics_with_jwt: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayService' application/yaml: schema: $ref: '#/components/schemas/GatewayService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Gateway Service object by name or id operationId: gateway_service_del security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/force' responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/GatewayService' application/yaml: schema: $ref: '#/components/schemas/GatewayService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/reset-oauth-secret: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' post: summary: Reset the oauth shared crypto material operationId: gateway_service_resetOauthSecret security: - oauth: - org:manage responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayService' application/yaml: schema: $ref: '#/components/schemas/GatewayService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/download-logs: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' get: summary: Get the Gateway Service download logs operationId: gateway_service_downloadLogs security: - oauth: - org:manage responses: '200': description: Success content: application/octet-stream: {} 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies: description: Policy operations across all collections parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' get: summary: List all Policy objects in all collections operationId: policy_listAllOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PolicyList' application/yaml: schema: $ref: '#/components/schemas/PolicyList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-name}: description: The collection of Policy operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/policy-name' get: summary: List the Policy objects operationId: policy_listOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PolicyList' application/yaml: schema: $ref: '#/components/schemas/PolicyList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-id}: description: Policy object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/policy-id' get: summary: Get the Policy object by id operationId: policy_getOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Policy' application/yaml: schema: $ref: '#/components/schemas/Policy' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path ? /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-name}/{policy-version} : description: Policy object operations by name and version parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/policy-name' - $ref: '#/components/parameters/policy-version' get: summary: Get the Policy object by name and version operationId: policy_getByNameVersionOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Policy' application/yaml: schema: $ref: '#/components/schemas/Policy' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-id}/document: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/policy-id' get: summary: Get the Policy document operationId: policy_getDocumentOrgScope security: - oauth: - org:manage responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PolicyDocument' application/yaml: schema: $ref: '#/components/schemas/PolicyDocument' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path ? /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-name}/{policy-version}/document : parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/policy-name' - $ref: '#/components/parameters/policy-version' get: summary: Get the Policy document by name and version operationId: policy_getDocumentByNameVersionOrgScope security: - oauth: - org:manage responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PolicyDocument' application/yaml: schema: $ref: '#/components/schemas/PolicyDocument' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions: description: Extension operations across all collections parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' get: summary: List all Extension objects in all collections operationId: extension_listAllOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExtensionList' application/yaml: schema: $ref: '#/components/schemas/ExtensionList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-name}: description: The collection of Extension operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/extension-name' get: summary: List the Extension objects operationId: extension_listOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExtensionList' application/yaml: schema: $ref: '#/components/schemas/ExtensionList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-id}: description: Extension object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/extension-id' get: summary: Get the Extension object by id operationId: extension_getOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Extension' application/yaml: schema: $ref: '#/components/schemas/Extension' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path ? /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-name}/{extension-version} : description: Extension object operations by name and version parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/extension-name' - $ref: '#/components/parameters/extension-version' get: summary: Get the Extension object by name and version operationId: extension_getByNameVersionOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Extension' application/yaml: schema: $ref: '#/components/schemas/Extension' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-id}/document: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/extension-id' get: summary: Get the Extension document operationId: extension_getDocumentOrgScope security: - oauth: - org:manage responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExtensionDocument' application/yaml: schema: $ref: '#/components/schemas/ExtensionDocument' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path ? /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-name}/{extension-version}/document : parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' - $ref: '#/components/parameters/extension-name' - $ref: '#/components/parameters/extension-version' get: summary: Get the Extension document by name and version operationId: extension_getDocumentByNameVersionOrgScope security: - oauth: - org:manage responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExtensionDocument' application/yaml: schema: $ref: '#/components/schemas/ExtensionDocument' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/gateway-extension: description: Gateway Extension object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' post: summary: Create the Gateway Extension object description: 'Create the Gateway Extension object Fields allowed but ignored: - name - type - api_version - scope - created_at - updated_at - url - org_url' operationId: gateway_extension_singletonCreateOrgScope security: - oauth: - org:view requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/GatewayExtensionMultipart' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayExtension' application/yaml: schema: $ref: '#/components/schemas/GatewayExtension' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: Get the Gateway Extension object operationId: gateway_extension_singletonGetOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayExtension' application/yaml: schema: $ref: '#/components/schemas/GatewayExtension' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources put: summary: Update the Gateway Extension object description: 'Update the Gateway Extension object Fields allowed but ignored: - name - type - api_version - scope - created_at - updated_at - url - org_url' operationId: gateway_extension_singletonUpdateOrgScope security: - oauth: - org:view requestBody: content: application/json: schema: $ref: '#/components/schemas/GatewayExtension' application/yaml: schema: $ref: '#/components/schemas/GatewayExtension' multipart/form-data: schema: $ref: '#/components/schemas/GatewayExtensionMultipart' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayExtension' application/yaml: schema: $ref: '#/components/schemas/GatewayExtension' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Gateway Extension object operationId: gateway_extension_singletonDelOrgScope security: - oauth: - org:view responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/GatewayExtension' application/yaml: schema: $ref: '#/components/schemas/GatewayExtension' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/gateway-extension/implementation: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/gateway-service' get: summary: Get the Gateway Extension implementation document operationId: gateway_extension_getImplementationOrgScope security: - oauth: - org:manage responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Implementation' application/yaml: schema: $ref: '#/components/schemas/Implementation' application/zip: {} 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/portal-services: description: The collection of Portal Service operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' post: summary: Create a Portal Service object description: 'Create a Portal Service object Required fields: - endpoint - web_endpoint_base Fields not allowed: - owned - service_supported_features Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - availability_zone_url' operationId: portal_service_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/PortalService' examples: PortalService: summary: Example portal service creation. value: name: acme-portal title: acme portal service summary: An example portal service endpoint: https://api.portal.acme-apim.example.com web_endpoint_base: https://portal.acme-apim.example.com communication_kind: external application/yaml: schema: $ref: '#/components/schemas/PortalService' examples: PortalService: summary: Example portal service creation. value: name: acme-portal title: acme portal service summary: An example portal service endpoint: https://api.portal.acme-apim.example.com web_endpoint_base: https://portal.acme-apim.example.com communication_kind: external responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/PortalService' application/yaml: schema: $ref: '#/components/schemas/PortalService' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Portal Service objects operationId: portal_service_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PortalServiceList' application/yaml: schema: $ref: '#/components/schemas/PortalServiceList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Portal Service objects operationId: portal_service_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' - $ref: '#/components/parameters/force' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/portal-services/{portal-service}: description: Portal Service object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/portal-service' get: summary: Get the Portal Service object by name or id operationId: portal_service_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PortalService' application/yaml: schema: $ref: '#/components/schemas/PortalService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Portal Service object by name or id description: 'Update the Portal Service object by name or id Fields not allowed to be null: - endpoint_tls_client_profile_url - web_endpoint_base Fields not allowed: - owned - endpoint - service_supported_features Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - availability_zone_url' operationId: portal_service_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/PortalService' examples: PortalService: summary: Example portal service update. value: title: acme portal service summary: An example portal service update web_endpoint_base: https://portal.acme-apim.example.com application/yaml: schema: $ref: '#/components/schemas/PortalService' examples: PortalService: summary: Example portal service update. value: title: acme portal service summary: An example portal service update web_endpoint_base: https://portal.acme-apim.example.com responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PortalService' application/yaml: schema: $ref: '#/components/schemas/PortalService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Portal Service object by name or id operationId: portal_service_del security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/force' responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/PortalService' application/yaml: schema: $ref: '#/components/schemas/PortalService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/portal-services/{portal-service}/update-credentials: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/portal-service' post: summary: Update the Portal Service configuration operationId: portal_service_updateCredentials security: - oauth: - org:manage responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateCredentialsResponse' application/yaml: schema: $ref: '#/components/schemas/UpdateCredentialsResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/analytics-services: description: The collection of Analytics Service operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' post: summary: Create a Analytics Service object description: 'Create a Analytics Service object Fields not allowed: - gateway_service_urls - ingestion_endpoint - client_endpoint Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - availability_zone_url' operationId: analytics_service_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/AnalyticsService' examples: AnalyticsService: summary: Example analytics service. value: name: acme-analytics-service title: ACME Analytics Service endpoint: https://a7s.acme-apim.example.com communication_from_apim_kind: external application/yaml: schema: $ref: '#/components/schemas/AnalyticsService' examples: AnalyticsService: summary: Example analytics service. value: name: acme-analytics-service title: ACME Analytics Service endpoint: https://a7s.acme-apim.example.com communication_from_apim_kind: external responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/AnalyticsService' application/yaml: schema: $ref: '#/components/schemas/AnalyticsService' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Analytics Service objects operationId: analytics_service_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AnalyticsServiceList' application/yaml: schema: $ref: '#/components/schemas/AnalyticsServiceList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Analytics Service objects operationId: analytics_service_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/availability-zones/{availability-zone}/analytics-services/{analytics-service}: description: Analytics Service object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/availability-zone' - $ref: '#/components/parameters/analytics-service' get: summary: Get the Analytics Service object by name or id operationId: analytics_service_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AnalyticsService' application/yaml: schema: $ref: '#/components/schemas/AnalyticsService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Analytics Service object by name or id description: 'Update the Analytics Service object by name or id Fields not allowed to be null: - ingestion_endpoint_tls_client_profile_url - client_endpoint_tls_client_profile_url Fields not allowed: - endpoint - ingestion_endpoint - client_endpoint Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - availability_zone_url' operationId: analytics_service_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/AnalyticsService' examples: AnalyticsService: summary: Example of fields which can be updated on an analytics service. value: title: ACME Updated Analytics Service summary: An example analytics service application/yaml: schema: $ref: '#/components/schemas/AnalyticsService' examples: AnalyticsService: summary: Example of fields which can be updated on an analytics service. value: title: ACME Updated Analytics Service summary: An example analytics service responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AnalyticsService' application/yaml: schema: $ref: '#/components/schemas/AnalyticsService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Analytics Service object by name or id operationId: analytics_service_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/AnalyticsService' application/yaml: schema: $ref: '#/components/schemas/AnalyticsService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/opentelemetries: description: The collection of Opentelemetry operations parameters: - $ref: '#/components/parameters/org' post: summary: Create a Opentelemetry object description: 'Create a Opentelemetry object Fields not allowed: - gateway_service_urls Required fields: - endpoints Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: opentelemetry_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Opentelemetry' examples: Opentelemetry: summary: Example of opentelemetry creation. value: name: opentelemetry title: Opentelemetry endpoints: - protocol: grpc endpoint: https://open_telemetry.com tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1 signals: - logs headers: - name: Authorization value: Bearer attributes: - name: env value: production batching: max-queue-size: 1000 batch-size: 500 export-interval: 3000 export-timeout: 50000 max-threads: 3 sampling: parent-based: true sampler-type: always_on sampler-ratio: 50 application/yaml: schema: $ref: '#/components/schemas/Opentelemetry' examples: Opentelemetry: summary: Example of opentelemetry creation. value: name: opentelemetry title: Opentelemetry endpoints: - protocol: grpc endpoint: https://open_telemetry.com tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1 signals: - logs headers: - name: Authorization value: Bearer attributes: - name: env value: production batching: max-queue-size: 1000 batch-size: 500 export-interval: 3000 export-timeout: 50000 max-threads: 3 sampling: parent-based: true sampler-type: always_on sampler-ratio: 50 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Opentelemetry' application/yaml: schema: $ref: '#/components/schemas/Opentelemetry' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Opentelemetry objects operationId: opentelemetry_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/OpentelemetryList' application/yaml: schema: $ref: '#/components/schemas/OpentelemetryList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Opentelemetry objects operationId: opentelemetry_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/opentelemetries/{opentelemetry}: description: Opentelemetry object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/opentelemetry' get: summary: Get the Opentelemetry object by name or id operationId: opentelemetry_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Opentelemetry' application/yaml: schema: $ref: '#/components/schemas/Opentelemetry' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Opentelemetry object by name or id description: 'Update the Opentelemetry object by name or id Fields not allowed: - gateway_service_urls Required fields: - endpoints Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: opentelemetry_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Opentelemetry' examples: Opentelemetry: summary: Example of opentelemetry update. value: title: Opentelemetry endpoints: - protocol: grpc endpoint: https://open_telemetry.com tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1 signals: - logs headers: - name: Authorization value: Bearer attributes: - name: env value: production batching: max-queue-size: 1000 batch-size: 500 export-interval: 3000 export-timeout: 50000 max-threads: 3 sampling: parent-based: true sampler-type: always_on sampler-ratio: 50 application/yaml: schema: $ref: '#/components/schemas/Opentelemetry' examples: Opentelemetry: summary: Example of opentelemetry update. value: title: Opentelemetry endpoints: - protocol: grpc endpoint: https://open_telemetry.com tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1 signals: - logs headers: - name: Authorization value: Bearer attributes: - name: env value: production batching: max-queue-size: 1000 batch-size: 500 export-interval: 3000 export-timeout: 50000 max-threads: 3 sampling: parent-based: true sampler-type: always_on sampler-ratio: 50 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Opentelemetry' application/yaml: schema: $ref: '#/components/schemas/Opentelemetry' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Opentelemetry object by name or id operationId: opentelemetry_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Opentelemetry' application/yaml: schema: $ref: '#/components/schemas/Opentelemetry' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/oauth-providers: description: The collection of Oauth Provider operations parameters: - $ref: '#/components/parameters/org' post: summary: Creates an OAuth provider description: 'Creates an OAuth provider resource. Fields allowed but ignored: - id - type - api_version - created_at - updated_at - url - org_url' operationId: oauth_provider_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/OauthProvider' examples: oauthProviderNativeCreate: summary: Example of native oauth provider creation. value: name: acme-oauth-provider title: Acme native oauth provider creation provider_type: native grants: - access_code - implicit - application - password gateway_version: '6000' native_provider: clients: - confidential - public authorize_path: /oauth2/authorize token_path: /oauth2/token api: info: description: sample decsription x-ibm-configuration: gateway: datapower-api-gateway basePath: /sample pkce: enabled: true required: false allow_plain: false native_provider_5000: {} scopes: sample_scope_1: Sample scope description oauthProviderThirdPartyCreate: summary: Example of third party oauth provider creation. value: name: acme-oauth-provider title: Acme third party oauth provider creation provider_type: third_party grants: - access_code - implicit - application - password - jwt gateway_version: '6000' third_party_config: token_validation_requirement: connected introspection_endpoint: endpoint: https://example.com/oauth2/introspect tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1 authorize_endpoint: https://example.com/oauth2/authorize token_endpoint: https://example.com/oauth2/token security: - basic-auth basic_auth: request_headername: x-introspect-basic-authorization-header username: acme password: acme@123 auth_header_pass_thru: true introspect_cache_type: protocol scopes: sample_scope_1: Sample scope description application/yaml: schema: $ref: '#/components/schemas/OauthProvider' examples: oauthProviderNativeCreate: summary: Example of native oauth provider creation. value: name: acme-oauth-provider title: Acme native oauth provider creation provider_type: native grants: - access_code - implicit - application - password gateway_version: '6000' native_provider: clients: - confidential - public authorize_path: /oauth2/authorize token_path: /oauth2/token api: info: description: sample decsription x-ibm-configuration: gateway: datapower-api-gateway basePath: /sample pkce: enabled: true required: false allow_plain: false native_provider_5000: {} scopes: sample_scope_1: Sample scope description oauthProviderThirdPartyCreate: summary: Example of third party oauth provider creation. value: name: acme-oauth-provider title: Acme third party oauth provider creation provider_type: third_party grants: - access_code - implicit - application - password - jwt gateway_version: '6000' third_party_config: token_validation_requirement: connected introspection_endpoint: endpoint: https://example.com/oauth2/introspect tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1 authorize_endpoint: https://example.com/oauth2/authorize token_endpoint: https://example.com/oauth2/token security: - basic-auth basic_auth: request_headername: x-introspect-basic-authorization-header username: acme password: acme@123 auth_header_pass_thru: true introspect_cache_type: protocol scopes: sample_scope_1: Sample scope description responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/OauthProvider' application/yaml: schema: $ref: '#/components/schemas/OauthProvider' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: Lists OAuth providers description: Returns the list of all OAuth provider resources. operationId: oauth_provider_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/OauthProviderList' application/yaml: schema: $ref: '#/components/schemas/OauthProviderList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clears OAuth providers description: Deletes all OAuth provider resources. operationId: oauth_provider_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/oauth-providers/{oauth-provider}: description: Oauth Provider object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/oauth-provider' get: summary: Returns an OAuth provider description: Returns an OAuth provider resource. operationId: oauth_provider_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/OauthProvider' application/yaml: schema: $ref: '#/components/schemas/OauthProvider' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Creates an OAuth provider description: 'Updates an OAuth provider resource. Fields allowed but ignored: - id - type - api_version - created_at - updated_at - url - org_url' operationId: oauth_provider_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/OauthProvider' examples: OauthProvider: summary: Example of native oauth provider update. value: title: Acme native oauth provider creation grants: - access_code - implicit - application native_provider: clients: - confidential authorize_path: /oauth2/authorize1 token_path: /oauth2/token1 api: info: description: updated description basePath: /sample1 pkce: enabled: false required: true allow_plain: true scopes: sample_scope_1: updated scope description application/yaml: schema: $ref: '#/components/schemas/OauthProvider' examples: OauthProvider: summary: Example of native oauth provider update. value: title: Acme native oauth provider creation grants: - access_code - implicit - application native_provider: clients: - confidential authorize_path: /oauth2/authorize1 token_path: /oauth2/token1 api: info: description: updated description basePath: /sample1 pkce: enabled: false required: true allow_plain: true scopes: sample_scope_1: updated scope description responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/OauthProvider' application/yaml: schema: $ref: '#/components/schemas/OauthProvider' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Deletes an OAuth provider description: Deletes an OAuth provider resource. operationId: oauth_provider_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/OauthProvider' application/yaml: schema: $ref: '#/components/schemas/OauthProvider' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/jwt-providers: description: The collection of Jwt Provider operations parameters: - $ref: '#/components/parameters/org' post: summary: Create a Jwt Provider object description: 'Create a Jwt Provider object Fields allowed but ignored: - id - type - api_version - created_at - updated_at - url - org_url' operationId: jwt_provider_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/JwtProvider' examples: JWTProvider: summary: Example for JWT provider create value: name: JWTProvider title: JWT Provider summary: Example for creating JWT Provider debug: false gateway_version: '12000' native_jwt_provider: jwks_config: signing tls_client_profile_urls: - https://api.acme-apim.example.com/api/orgs/acme-org/tls-client-profiles/acme-tls-client-profile application/yaml: schema: $ref: '#/components/schemas/JwtProvider' examples: JWTProvider: summary: Example for JWT provider create value: name: JWTProvider title: JWT Provider summary: Example for creating JWT Provider debug: false gateway_version: '12000' native_jwt_provider: jwks_config: signing tls_client_profile_urls: - https://api.acme-apim.example.com/api/orgs/acme-org/tls-client-profiles/acme-tls-client-profile responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/JwtProvider' application/yaml: schema: $ref: '#/components/schemas/JwtProvider' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Jwt Provider objects operationId: jwt_provider_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/JwtProviderList' application/yaml: schema: $ref: '#/components/schemas/JwtProviderList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Jwt Provider objects operationId: jwt_provider_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/jwt-providers/{jwt-provider}: description: Jwt Provider object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/jwt-provider' get: summary: Get the Jwt Provider object by name or id operationId: jwt_provider_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/JwtProvider' application/yaml: schema: $ref: '#/components/schemas/JwtProvider' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Jwt Provider object by name or id description: 'Update the Jwt Provider object by name or id Required fields: - jwks_config Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: jwt_provider_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/JwtProvider' examples: JWTProvider: summary: Example for JWT provider update value: title: JWT Provider summary: Example for updating JWT Provider debug: false gateway_version: '12000' native_jwt_provider: jwks_config: signing tls_client_profile_urls: - https://api.acme-apim.example.com/api/orgs/acme-org/tls-client-profiles/acme-tls-client-profile application/yaml: schema: $ref: '#/components/schemas/JwtProvider' examples: JWTProvider: summary: Example for JWT provider update value: title: JWT Provider summary: Example for updating JWT Provider debug: false gateway_version: '12000' native_jwt_provider: jwks_config: signing tls_client_profile_urls: - https://api.acme-apim.example.com/api/orgs/acme-org/tls-client-profiles/acme-tls-client-profile responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/JwtProvider' application/yaml: schema: $ref: '#/components/schemas/JwtProvider' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Jwt Provider object by name or id operationId: jwt_provider_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/JwtProvider' application/yaml: schema: $ref: '#/components/schemas/JwtProvider' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/mail-servers: description: The collection of Mail Server operations parameters: - $ref: '#/components/parameters/org' post: summary: Create a Mail Server object description: 'Create a Mail Server object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: mail_server_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/MailServer' examples: MailServer: summary: Example of mail server creation. value: name: acme-mailserver title: acme mail server host: acme.example.com port: 25 credentials: username: acmeuser password: Passw0rd123 secure: true tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1 application/yaml: schema: $ref: '#/components/schemas/MailServer' examples: MailServer: summary: Example of mail server creation. value: name: acme-mailserver title: acme mail server host: acme.example.com port: 25 credentials: username: acmeuser password: Passw0rd123 secure: true tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/MailServer' application/yaml: schema: $ref: '#/components/schemas/MailServer' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Mail Server objects operationId: mail_server_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MailServerList' application/yaml: schema: $ref: '#/components/schemas/MailServerList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Mail Server objects operationId: mail_server_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/mail-servers/{mail-server}: description: Mail Server object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/mail-server' get: summary: Get the Mail Server object by name or id operationId: mail_server_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MailServer' application/yaml: schema: $ref: '#/components/schemas/MailServer' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Mail Server object by name or id description: 'Update the Mail Server object by name or id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: mail_server_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/MailServer' examples: MailServer: summary: Example of mail server update. value: title: acme mailserver update host: acme.sample.com port: 25 credentials: username: acmeuser password: Passw0rd secure: false application/yaml: schema: $ref: '#/components/schemas/MailServer' examples: MailServer: summary: Example of mail server update. value: title: acme mailserver update host: acme.sample.com port: 25 credentials: username: acmeuser password: Passw0rd secure: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MailServer' application/yaml: schema: $ref: '#/components/schemas/MailServer' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Mail Server object by name or id operationId: mail_server_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/MailServer' application/yaml: schema: $ref: '#/components/schemas/MailServer' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/mail-servers/{mail-server}/test-connection: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/mail-server' post: summary: Test a Mail Server connection operationId: mail_server_testConnectionByIdOrName security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/MailServerSavedTestConnection' application/yaml: schema: $ref: '#/components/schemas/MailServerSavedTestConnection' examples: MailServerSavedTestConnection: summary: Example of mail server test connection. value: recipients: - acme@example.com MailServerProvidedTestConnection: summary: Example of mail server test connection (test config only). value: mail_server: name: acme-mail-server title: Acme mail server test connection host: acme.example.com port: 25 credentials: username: Acme password: Passw0rd secure: true recipients: - acme@example.com responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/mail-servers/test-connection: parameters: - $ref: '#/components/parameters/org' post: summary: Test a Mail Server connection operationId: mail_server_testConnection security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/MailServerProvidedTestConnection' application/yaml: schema: $ref: '#/components/schemas/MailServerProvidedTestConnection' examples: MailServerSavedTestConnection: summary: Example of mail server test connection. value: recipients: - acme@example.com MailServerProvidedTestConnection: summary: Example of mail server test connection (test config only). value: mail_server: name: acme-mail-server title: Acme mail server test connection host: acme.example.com port: 25 credentials: username: Acme password: Passw0rd secure: true recipients: - acme@example.com responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/tls-server-profiles: description: TLS Server Profile operations across all collections parameters: - $ref: '#/components/parameters/org' post: summary: Create a TLS Server Profile object description: 'Create a TLS Server Profile object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: tls_server_profile_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' examples: TLSServerProfile: summary: Example of tls server profile creation. value: title: acme TLS Server Profile name: acme-tls-server-profile version: 1.0.0 summary: An example TLS server profile mutual_authentication: request limit_renegotiation: true keystore_url: https://acme-apim.example.com/api/orgs/acmeorg/keystores/acmekeystore truststore_url: https://acme-apim.example.com/api/orgs/acmeorg/truststores/acmetruststore protocols: - tls_v1.0 - tls_v1.1 - tls_v1.2 - tls_v1.3 ciphers: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - TLS_AES_128_CCM_SHA256 - TLS_AES_128_CCM_8_SHA256 - ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - ECDHE_RSA_WITH_AES_256_GCM_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_256_CBC_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA - ECDHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 - DHE_DSS_WITH_AES_256_CBC_SHA256 - DHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_CBC_SHA - RSA_WITH_AES_256_GCM_SHA384 - RSA_WITH_AES_256_CBC_SHA256 - RSA_WITH_AES_256_CBC_SHA - ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - ECDHE_RSA_WITH_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - ECDHE_RSA_WITH_AES_128_CBC_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA256 - DHE_DSS_WITH_AES_128_CBC_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_CBC_SHA - RSA_WITH_AES_128_GCM_SHA256 - RSA_WITH_AES_128_CBC_SHA256 - RSA_WITH_AES_128_CBC_SHA - ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_DSS_WITH_3DES_EDE_CBC_SHA - RSA_WITH_3DES_EDE_CBC_SHA application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' examples: TLSServerProfile: summary: Example of tls server profile creation. value: title: acme TLS Server Profile name: acme-tls-server-profile version: 1.0.0 summary: An example TLS server profile mutual_authentication: request limit_renegotiation: true keystore_url: https://acme-apim.example.com/api/orgs/acmeorg/keystores/acmekeystore truststore_url: https://acme-apim.example.com/api/orgs/acmeorg/truststores/acmetruststore protocols: - tls_v1.0 - tls_v1.1 - tls_v1.2 - tls_v1.3 ciphers: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - TLS_AES_128_CCM_SHA256 - TLS_AES_128_CCM_8_SHA256 - ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - ECDHE_RSA_WITH_AES_256_GCM_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_256_CBC_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA - ECDHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 - DHE_DSS_WITH_AES_256_CBC_SHA256 - DHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_CBC_SHA - RSA_WITH_AES_256_GCM_SHA384 - RSA_WITH_AES_256_CBC_SHA256 - RSA_WITH_AES_256_CBC_SHA - ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - ECDHE_RSA_WITH_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - ECDHE_RSA_WITH_AES_128_CBC_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA256 - DHE_DSS_WITH_AES_128_CBC_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_CBC_SHA - RSA_WITH_AES_128_GCM_SHA256 - RSA_WITH_AES_128_CBC_SHA256 - RSA_WITH_AES_128_CBC_SHA - ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_DSS_WITH_3DES_EDE_CBC_SHA - RSA_WITH_3DES_EDE_CBC_SHA responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List all TLS Server Profile objects in all collections operationId: tls_server_profile_listAll security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSServerProfileList' application/yaml: schema: $ref: '#/components/schemas/TLSServerProfileList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear all TLS Server Profile objects in all collections operationId: tls_server_profile_clearAll security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' - $ref: '#/components/parameters/cascade' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/tls-server-profiles/{tls-server-profile-name}: description: The collection of TLS Server Profile operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/tls-server-profile-name' get: summary: List the TLS Server Profile objects operationId: tls_server_profile_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSServerProfileList' application/yaml: schema: $ref: '#/components/schemas/TLSServerProfileList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the TLS Server Profile objects operationId: tls_server_profile_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' - $ref: '#/components/parameters/cascade' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/tls-server-profiles/{tls-server-profile-id}: description: TLS Server Profile object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/tls-server-profile-id' get: summary: Get the TLS Server Profile object by id operationId: tls_server_profile_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the TLS Server Profile object by id description: 'Update the TLS Server Profile object by id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: tls_server_profile_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' examples: TLSServerProfile: summary: Example of tls server profile update by id. value: title: acme TLS Server profile update version: 1.0.0 summary: An example TLS server profile update mutual_authentication: require limit_renegotiation: false keystore_url: https://acme-apim.example.com/api/orgs/acmeorg/keystores/acmekeystore truststore_url: https://acme-apim.example.com/api/orgs/acmeorg/truststores/acmetruststore protocols: - tls_v1.2 - tls_v1.3 ciphers: - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' examples: TLSServerProfile: summary: Example of tls server profile update by id. value: title: acme TLS Server profile update version: 1.0.0 summary: An example TLS server profile update mutual_authentication: require limit_renegotiation: false keystore_url: https://acme-apim.example.com/api/orgs/acmeorg/keystores/acmekeystore truststore_url: https://acme-apim.example.com/api/orgs/acmeorg/truststores/acmetruststore protocols: - tls_v1.2 - tls_v1.3 ciphers: - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the TLS Server Profile object by id operationId: tls_server_profile_del security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/cascade' responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/tls-server-profiles/{tls-server-profile-name}/{tls-server-profile-version}: description: TLS Server Profile object operations by name and version parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/tls-server-profile-name' - $ref: '#/components/parameters/tls-server-profile-version' get: summary: Get the TLS Server Profile object by name and version operationId: tls_server_profile_getByNameVersion security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the TLS Server Profile object by name and version description: 'Update the TLS Server Profile object by name and version Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: tls_server_profile_updateByNameVersion security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' examples: TLSServerProfile: summary: Example of tls server profile update by name and version. value: title: acme TLS Server profile update version: 1.0.0 summary: An example TLS server profile update mutual_authentication: require limit_renegotiation: false keystore_url: https://acme-apim.example.com/api/orgs/acmeorg/keystores/acmekeystore truststore_url: https://acme-apim.example.com/api/orgs/acmeorg/truststores/acmetruststore protocols: - tls_v1.2 - tls_v1.3 ciphers: - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' examples: TLSServerProfile: summary: Example of tls server profile update by name and version. value: title: acme TLS Server profile update version: 1.0.0 summary: An example TLS server profile update mutual_authentication: require limit_renegotiation: false keystore_url: https://acme-apim.example.com/api/orgs/acmeorg/keystores/acmekeystore truststore_url: https://acme-apim.example.com/api/orgs/acmeorg/truststores/acmetruststore protocols: - tls_v1.2 - tls_v1.3 ciphers: - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete a TLS Server Profile operationId: tls_server_profile_delByNameVersion security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/TLSServerProfile' application/yaml: schema: $ref: '#/components/schemas/TLSServerProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/tls-client-profiles: description: TLS Client Profile operations across all collections parameters: - $ref: '#/components/parameters/org' post: summary: Creates a TLS client profile description: 'Creates a TLS client profile. Fields not allowed: - owned Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: tls_client_profile_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' examples: TLSClientProfile: summary: Example of tls client profile creation. value: title: acme TLS Client Profile name: acme-tls-client-profile version: 1.0.0 summary: An example TLS client profile insecure_server_connections: true server_name_indication: false keystore_url: https://acme-apim.example.com/api/orgs/acme-org/keystores/acme-keystore truststore_url: https://acme-apim.example.com/api/orgs/acme-org/truststores/acme-truststore protocols: - tls_v1.0 - tls_v1.1 - tls_v1.2 - tls_v1.3 ciphers: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - TLS_AES_128_CCM_SHA256 - TLS_AES_128_CCM_8_SHA256 - ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - ECDHE_RSA_WITH_AES_256_GCM_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_256_CBC_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA - ECDHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 - DHE_DSS_WITH_AES_256_CBC_SHA256 - DHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_CBC_SHA - RSA_WITH_AES_256_GCM_SHA384 - RSA_WITH_AES_256_CBC_SHA256 - RSA_WITH_AES_256_CBC_SHA - ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - ECDHE_RSA_WITH_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - ECDHE_RSA_WITH_AES_128_CBC_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA256 - DHE_DSS_WITH_AES_128_CBC_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_CBC_SHA - RSA_WITH_AES_128_GCM_SHA256 - RSA_WITH_AES_128_CBC_SHA256 - RSA_WITH_AES_128_CBC_SHA - ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_DSS_WITH_3DES_EDE_CBC_SHA - RSA_WITH_3DES_EDE_CBC_SHA application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' examples: TLSClientProfile: summary: Example of tls client profile creation. value: title: acme TLS Client Profile name: acme-tls-client-profile version: 1.0.0 summary: An example TLS client profile insecure_server_connections: true server_name_indication: false keystore_url: https://acme-apim.example.com/api/orgs/acme-org/keystores/acme-keystore truststore_url: https://acme-apim.example.com/api/orgs/acme-org/truststores/acme-truststore protocols: - tls_v1.0 - tls_v1.1 - tls_v1.2 - tls_v1.3 ciphers: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - TLS_AES_128_CCM_SHA256 - TLS_AES_128_CCM_8_SHA256 - ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - ECDHE_RSA_WITH_AES_256_GCM_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_256_CBC_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA - ECDHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 - DHE_DSS_WITH_AES_256_CBC_SHA256 - DHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_CBC_SHA - RSA_WITH_AES_256_GCM_SHA384 - RSA_WITH_AES_256_CBC_SHA256 - RSA_WITH_AES_256_CBC_SHA - ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - ECDHE_RSA_WITH_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - ECDHE_RSA_WITH_AES_128_CBC_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA256 - DHE_DSS_WITH_AES_128_CBC_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_CBC_SHA - RSA_WITH_AES_128_GCM_SHA256 - RSA_WITH_AES_128_CBC_SHA256 - RSA_WITH_AES_128_CBC_SHA - ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_DSS_WITH_3DES_EDE_CBC_SHA - RSA_WITH_3DES_EDE_CBC_SHA responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: Lists TLS client profiles description: Returns the list of all TLS client profiles belonging to a provider organization. operationId: tls_client_profile_listAll security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSClientProfileList' application/yaml: schema: $ref: '#/components/schemas/TLSClientProfileList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clears TLS client profiles description: Removes all TLS client profiles belonging to a provider organization. operationId: tls_client_profile_clearAll security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' - $ref: '#/components/parameters/cascade' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/tls-client-profiles/{tls-client-profile-name}: description: The collection of TLS Client Profile operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/tls-client-profile-name' get: summary: Lists TLS client profile versions description: Returns all versions of the named TLS client profile belonging to a provider organization. operationId: tls_client_profile_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSClientProfileList' application/yaml: schema: $ref: '#/components/schemas/TLSClientProfileList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clears TLS client profile versions description: Removes all versions of the named TLS client profile belonging to a provider organization. operationId: tls_client_profile_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/tls-client-profiles/{tls-client-profile-id}: description: TLS Client Profile object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/tls-client-profile-id' get: summary: Returns a TLS client profile description: Returns a TLS client profile belonging to a provider organization. operationId: tls_client_profile_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Updates a TLS client profile description: 'Updates a TLS client profile. Fields not allowed: - owned Fields not allowed to be null: - ciphers - protocols Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: tls_client_profile_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' examples: TLSClientProfile: summary: Example of tls client profile update by id. value: title: acme TLS Client profile update version: 1.0.0 summary: An example TLS client profile update insecure_server_connections: true server_name_indication: false keystore_url: https://acme-apim.example.com/api/orgs/acme-org/keystores/acme-keystore truststore_url: https://acme-apim.example.com/api/orgs/acme-org/truststores/acme-truststore protocols: - tls_v1.2 - tls_v1.3 ciphers: - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' examples: TLSClientProfile: summary: Example of tls client profile update by id. value: title: acme TLS Client profile update version: 1.0.0 summary: An example TLS client profile update insecure_server_connections: true server_name_indication: false keystore_url: https://acme-apim.example.com/api/orgs/acme-org/keystores/acme-keystore truststore_url: https://acme-apim.example.com/api/orgs/acme-org/truststores/acme-truststore protocols: - tls_v1.2 - tls_v1.3 ciphers: - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Deletes a TLS client profile description: Deletes a TLS client profile belonging to a provider organization. operationId: tls_client_profile_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}: description: TLS Client Profile object operations by name and version parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/tls-client-profile-name' - $ref: '#/components/parameters/tls-client-profile-version' get: summary: Returns a TLS client profile description: Returns a TLS client profile belonging to a provider organization. operationId: tls_client_profile_getByNameVersion security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Updates a TLS client profile description: 'Updates a TLS client profile. Fields not allowed: - owned Fields not allowed to be null: - ciphers - protocols Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: tls_client_profile_updateByNameVersion security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' examples: TLSClientProfile: summary: Example of tls client profile update by name and version. value: title: acme TLS Client profile update version: 1.0.0 summary: An example TLS client profile update insecure_server_connections: true server_name_indication: false keystore_url: https://acme-apim.example.com/api/orgs/acme-org/keystores/acme-keystore truststore_url: https://acme-apim.example.com/api/orgs/acme-org/truststores/acme-truststore protocols: - tls_v1.2 - tls_v1.3 ciphers: - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' examples: TLSClientProfile: summary: Example of tls client profile update by name and version. value: title: acme TLS Client profile update version: 1.0.0 summary: An example TLS client profile update insecure_server_connections: true server_name_indication: false keystore_url: https://acme-apim.example.com/api/orgs/acme-org/keystores/acme-keystore truststore_url: https://acme-apim.example.com/api/orgs/acme-org/truststores/acme-truststore protocols: - tls_v1.2 - tls_v1.3 ciphers: - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete a TLS Client Profile operationId: tls_client_profile_delByNameVersion security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/TLSClientProfile' application/yaml: schema: $ref: '#/components/schemas/TLSClientProfile' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/keystores: description: The collection of Keystore operations parameters: - $ref: '#/components/parameters/org' post: summary: Creates a keystore description: 'Creates a keystore belonging to a provider organization. Required fields: - keystore Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: keystore_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Keystore' examples: Keystore: summary: Example of keystore creation. value: title: Acme keystore creation name: acme-keystore summary: An example keystore creation password: Acme1234 keystore: "-----BEGIN CERTIFICATE-----\nMIIC7jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG\nA1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3BxETAPBgNVBAoTCEZyYW5rNERE\nMRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBucnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl\nYiCDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw\nODIyMDUyNzQxWhcNMTcwODIxMDUyNzQxWeBKMQswCQYDVQQGEwJKUDEOMAwGA1UE\nCAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBs\nZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0z9FeMynsC8+u\ndvX+LciZxnh5uRj4C9S6tNeeAlIGCfQYk0zUcNFCoCkTknNQd/YEiawDLNbxBqut\nbMDZ1aarys1a1lYmUeVLCIqvzBkPJTSQsCopQQ9V8WuT252zzNzs68dVGNdCJd5J\nNRQykpwexmnjPPv0mvj7i8XgG379TyW6P+WWV5okeUkXJ9eJS2ouDYdR2SM9BoVW\n+FgxDu6BmXhozW5EfsnajFp7HL8kQClI0QOc79yuKl3492rH6bzFsFn2lfwWy9ic\n7cP8EpCTeFp1tFaD+vxBhPZkeTQ1HKx6hQ5zeHIB5ySJJZ7af8W8r4eTGYzbdRW2\n4DDHCPhZAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAQMv+BFvGdMVzkQaQ3/+2noVz\n/uAKbzpEL8xTcxYyP3lkOeh4FoxiSWqy5pGFALdPONoDuYFpLhjJSZaEwuvjI/Tr\nrGhLV1pRG9frwDFshqD2Vaj4ENBCBh6UpeBop5+285zQ4SI7q4U9oSebUDJiuOx6\n+tZ9KynmrbJpTSi0+BM=\n-----END CERTIFICATE-----\n-----BEGIN RSA PRIVATE KEY-----\nMII7pAIBABKCAQEAtM/RXjMp7AvPrnb1/i3ImcZ4ebkY+AvUurTXngJSBgn0GJNM\n1HDRQqApE5JzUHf2BImsAyzW8QarrWzA2dWmq8rNWtJWJlHlSwiKr8wZDyU0kLAq\nKUEPVfFrk9uds8zc7OvHVRjXQiXeSTUUMpKcHsZp4zz79Jr4+4vF4Bt+/U8luj/l\nlleaJHlJFyfXiUtqLg2HUdkjPQaFVvhYMQ7ugZl4aM1uRH7J2oxaexy/JEApSNED\nnO/cripd+Pdqx+m8xbBZ9pX8FsvYnO3D/BKQk3hadbRWg/r8QYT2ZHk0NRyseoUO\nc3hyAeckiSWe3n9lvK+HkxmM23UVtuAwxwj4WQIDAQABAoIBAE76H0d4La2PEy3v\nhE98DA0vJdx1PzTJZigPacb42H8OxfIeFQcOKDlj381OwNO7MliVEe9pHJG3CjH8\nONhtfBm5wa0UBtFCIFd/6aQUEDYPWECC0kemxV4Sz5yL5vxsVWufKThAW3XnOIrd\nhm74nvzKSeIZ9yvGrU6ipNHY8MUPm0DQVrVYE5MiKjKVExQ4uRAolV2hlmeQDlSt\nk85S0TUOWO1EvJZhsVVs7dBjjY10hIjv3gZPAO8CN75JzMeaNbmWv4RQj0B967in\nrqlOa5qYYt80tAWO4hmPRKCrv6PgThz8C0Cd8AgwNzvQD2d4JpmxxTzBT6/5lRng\nHhj/wQECgYEA2jxC0a4lGmp1q2aYE1Zyiq0UqjxA92pwFYJg3800MLkf96A+dOhd\nwDAc5aAKN8vQV5g33vKi5+pIHWUCskhTS8/PPGrfeqIvtphCj6b7LKosBOhdzrRD\nOsr+Az/SiR2h5l2lr/v7I8I86RTY7MBk4QcRb601kSagWLDNVzSSdhECgYEA1Bm0\n0sByqkQmFoUNRkwmShPfJeVLTCr1G4cllml6MqHmGyRDHxtcp1+CXlyJJemLQY2A\nqrM7/T4x2ta6ME2WgDydFe9M8oU3BbefNYovS6YnoyBqxCx7yZ1vO0Jo40rZI8Bi\nKoCi6e0Hugg4xyPRz9TTNLmr/yEC1qQesMhM9ckCgYEArsT7rfgMdq8zNOSgfTwJ\n1sztc7d1P67ZvCABfLlVRn+6/hAydGVyTus4+RvFkxGB8+RPOhiOJbQVtJSkKCqL\nqnbtu7DK7+ba1xvwkiJjnE1bm0KLfXIXNQpDik6eSHiWo2nzuo/Ne8GeDftIDbG2\nGBAVAp5v+6I3X0+X4nKTqEECgYEAwT4Cj5mjXxnkEdR7eahHwmpEf0RfzC+/Tate\nRXZsrUDwY34wYWEOk7fjEZIBqrcTl1ATEHNojpxh096bmHK4UnHnNRrn4nYY4W6g\n8ajK2oOxzWA1pjJZPiHgO/+PjLafC4G2br7wr2y0A3yGLnmmKVLgc0NPP42WBnVV\nOP/ljnECgYABlDdJCAehDNSv4mdEzY5bfD+VBFd2QsgE1hYhmUYYRNlgIfIL9Y8e\nCduqXFLNZ/LHdmtYembgUqrMiJTUqcbSrJt26kBQx0az3LAV+J2p68PQ85KR9ZPy\nN1jEnRqpAwEdw7S+8l0yVyaNkm66eRI80p+w3AxNbS9hJ/7UlV3lGA==\n-----END RSA PRIVATE KEY----- \n" application/yaml: schema: $ref: '#/components/schemas/Keystore' examples: Keystore: summary: Example of keystore creation. value: title: Acme keystore creation name: acme-keystore summary: An example keystore creation password: Acme1234 keystore: "-----BEGIN CERTIFICATE-----\nMIIC7jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG\nA1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3BxETAPBgNVBAoTCEZyYW5rNERE\nMRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBucnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl\nYiCDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw\nODIyMDUyNzQxWhcNMTcwODIxMDUyNzQxWeBKMQswCQYDVQQGEwJKUDEOMAwGA1UE\nCAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBs\nZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0z9FeMynsC8+u\ndvX+LciZxnh5uRj4C9S6tNeeAlIGCfQYk0zUcNFCoCkTknNQd/YEiawDLNbxBqut\nbMDZ1aarys1a1lYmUeVLCIqvzBkPJTSQsCopQQ9V8WuT252zzNzs68dVGNdCJd5J\nNRQykpwexmnjPPv0mvj7i8XgG379TyW6P+WWV5okeUkXJ9eJS2ouDYdR2SM9BoVW\n+FgxDu6BmXhozW5EfsnajFp7HL8kQClI0QOc79yuKl3492rH6bzFsFn2lfwWy9ic\n7cP8EpCTeFp1tFaD+vxBhPZkeTQ1HKx6hQ5zeHIB5ySJJZ7af8W8r4eTGYzbdRW2\n4DDHCPhZAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAQMv+BFvGdMVzkQaQ3/+2noVz\n/uAKbzpEL8xTcxYyP3lkOeh4FoxiSWqy5pGFALdPONoDuYFpLhjJSZaEwuvjI/Tr\nrGhLV1pRG9frwDFshqD2Vaj4ENBCBh6UpeBop5+285zQ4SI7q4U9oSebUDJiuOx6\n+tZ9KynmrbJpTSi0+BM=\n-----END CERTIFICATE-----\n-----BEGIN RSA PRIVATE KEY-----\nMII7pAIBABKCAQEAtM/RXjMp7AvPrnb1/i3ImcZ4ebkY+AvUurTXngJSBgn0GJNM\n1HDRQqApE5JzUHf2BImsAyzW8QarrWzA2dWmq8rNWtJWJlHlSwiKr8wZDyU0kLAq\nKUEPVfFrk9uds8zc7OvHVRjXQiXeSTUUMpKcHsZp4zz79Jr4+4vF4Bt+/U8luj/l\nlleaJHlJFyfXiUtqLg2HUdkjPQaFVvhYMQ7ugZl4aM1uRH7J2oxaexy/JEApSNED\nnO/cripd+Pdqx+m8xbBZ9pX8FsvYnO3D/BKQk3hadbRWg/r8QYT2ZHk0NRyseoUO\nc3hyAeckiSWe3n9lvK+HkxmM23UVtuAwxwj4WQIDAQABAoIBAE76H0d4La2PEy3v\nhE98DA0vJdx1PzTJZigPacb42H8OxfIeFQcOKDlj381OwNO7MliVEe9pHJG3CjH8\nONhtfBm5wa0UBtFCIFd/6aQUEDYPWECC0kemxV4Sz5yL5vxsVWufKThAW3XnOIrd\nhm74nvzKSeIZ9yvGrU6ipNHY8MUPm0DQVrVYE5MiKjKVExQ4uRAolV2hlmeQDlSt\nk85S0TUOWO1EvJZhsVVs7dBjjY10hIjv3gZPAO8CN75JzMeaNbmWv4RQj0B967in\nrqlOa5qYYt80tAWO4hmPRKCrv6PgThz8C0Cd8AgwNzvQD2d4JpmxxTzBT6/5lRng\nHhj/wQECgYEA2jxC0a4lGmp1q2aYE1Zyiq0UqjxA92pwFYJg3800MLkf96A+dOhd\nwDAc5aAKN8vQV5g33vKi5+pIHWUCskhTS8/PPGrfeqIvtphCj6b7LKosBOhdzrRD\nOsr+Az/SiR2h5l2lr/v7I8I86RTY7MBk4QcRb601kSagWLDNVzSSdhECgYEA1Bm0\n0sByqkQmFoUNRkwmShPfJeVLTCr1G4cllml6MqHmGyRDHxtcp1+CXlyJJemLQY2A\nqrM7/T4x2ta6ME2WgDydFe9M8oU3BbefNYovS6YnoyBqxCx7yZ1vO0Jo40rZI8Bi\nKoCi6e0Hugg4xyPRz9TTNLmr/yEC1qQesMhM9ckCgYEArsT7rfgMdq8zNOSgfTwJ\n1sztc7d1P67ZvCABfLlVRn+6/hAydGVyTus4+RvFkxGB8+RPOhiOJbQVtJSkKCqL\nqnbtu7DK7+ba1xvwkiJjnE1bm0KLfXIXNQpDik6eSHiWo2nzuo/Ne8GeDftIDbG2\nGBAVAp5v+6I3X0+X4nKTqEECgYEAwT4Cj5mjXxnkEdR7eahHwmpEf0RfzC+/Tate\nRXZsrUDwY34wYWEOk7fjEZIBqrcTl1ATEHNojpxh096bmHK4UnHnNRrn4nYY4W6g\n8ajK2oOxzWA1pjJZPiHgO/+PjLafC4G2br7wr2y0A3yGLnmmKVLgc0NPP42WBnVV\nOP/ljnECgYABlDdJCAehDNSv4mdEzY5bfD+VBFd2QsgE1hYhmUYYRNlgIfIL9Y8e\nCduqXFLNZ/LHdmtYembgUqrMiJTUqcbSrJt26kBQx0az3LAV+J2p68PQ85KR9ZPy\nN1jEnRqpAwEdw7S+8l0yVyaNkm66eRI80p+w3AxNbS9hJ/7UlV3lGA==\n-----END RSA PRIVATE KEY----- \n" responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Keystore' application/yaml: schema: $ref: '#/components/schemas/Keystore' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: Lists keystores description: Lists all keystores belonging to a provider organization. operationId: keystore_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/KeystoreList' application/yaml: schema: $ref: '#/components/schemas/KeystoreList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clears keystores description: Removes all keystores belonging to a provider organization. operationId: keystore_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/keystores/{keystore}: description: Keystore object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/keystore' get: summary: Returns a keystore description: Returns a keystores belonging to a provider organization. operationId: keystore_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Keystore' application/yaml: schema: $ref: '#/components/schemas/Keystore' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Updates a keystore description: 'Updates a keystore belonging to a provider organization. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: keystore_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Keystore' examples: Keystore: summary: Example of keystore update. value: title: Acme keystore update summary: An example keystore update password: Acme123 private_key_entry: "-----BEGIN RSA PRIVATE KEY-----\nMII7pAIBABKCAQEAtM/RXjMp7AvPrnb1/i3ImcZ4ebkY+AvUurTXngJSBgn0GJNM\n1HDRQqApE5JzUHf2BImsAyzW8QarrWzA2dWmq8rNWtJWJlHlSwiKr8wZDyU0kLAq\nKUEPVfFrk9uds8zc7OvHVRjXQiXeSTUUMpKcHsZp4zz79Jr4+4vF4Bt+/U8luj/l\nlleaJHlJFyfXiUtqLg2HUdkjPQaFVvhYMQ7ugZl4aM1uRH7J2oxaexy/JEApSNED\nnO/cripd+Pdqx+m8xbBZ9pX8FsvYnO3D/BKQk3hadbRWg/r8QYT2ZHk0NRyseoUO\nc3hyAeckiSWe3n9lvK+HkxmM23UVtuAwxwj4WQIDAQABAoIBAE76H0d4La2PEy3v\nhE98DA0vJdx1PzTJZigPacb42H8OxfIeFQcOKDlj381OwNO7MliVEe9pHJG3CjH8\nONhtfBm5wa0UBtFCIFd/6aQUEDYPWECC0kemxV4Sz5yL5vxsVWufKThAW3XnOIrd\nhm74nvzKSeIZ9yvGrU6ipNHY8MUPm0DQVrVYE5MiKjKVExQ4uRAolV2hlmeQDlSt\nk85S0TUOWO1EvJZhsVVs7dBjjY10hIjv3gZPAO8CN75JzMeaNbmWv4RQj0B967in\nrqlOa5qYYt80tAWO4hmPRKCrv6PgThz8C0Cd8AgwNzvQD2d4JpmxxTzBT6/5lRng\nHhj/wQECgYEA2jxC0a4lGmp1q2aYE1Zyiq0UqjxA92pwFYJg3800MLkf96A+dOhd\nwDAc5aAKN8vQV5g33vKi5+pIHWUCskhTS8/PPGrfeqIvtphCj6b7LKosBOhdzrRD\nOsr+Az/SiR2h5l2lr/v7I8I86RTY7MBk4QcRb601kSagWLDNVzSSdhECgYEA1Bm0\n0sByqkQmFoUNRkwmShPfJeVLTCr1G4cllml6MqHmGyRDHxtcp1+CXlyJJemLQY2A\nqrM7/T4x2ta6ME2WgDydFe9M8oU3BbefNYovS6YnoyBqxCx7yZ1vO0Jo40rZI8Bi\nKoCi6e0Hugg4xyPRz9TTNLmr/yEC1qQesMhM9ckCgYEArsT7rfgMdq8zNOSgfTwJ\n1sztc7d1P67ZvCABfLlVRn+6/hAydGVyTus4+RvFkxGB8+RPOhiOJbQVtJSkKCqL\nqnbtu7DK7+ba1xvwkiJjnE1bm0KLfXIXNQpDik6eSHiWo2nzuo/Ne8GeDftIDbG2\nGBAVAp5v+6I3X0+X4nKTqEECgYEAwT4Cj5mjXxnkEdR7eahHwmpEf0RfzC+/Tate\nRXZsrUDwY34wYWEOk7fjEZIBqrcTl1ATEHNojpxh096bmHK4UnHnNRrn4nYY4W6g\n8ajK2oOxzWA1pjJZPiHgO/+PjLafC4G2br7wr2y0A3yGLnmmKVLgc0NPP42WBnVV\nOP/ljnECgYABlDdJCAehDNSv4mdEzY5bfD+VBFd2QsgE1hYhmUYYRNlgIfIL9Y8e\nCduqXFLNZ/LHdmtYembgUqrMiJTUqcbSrJt26kBQx0az3LAV+J2p68PQ85KR9ZPy\nN1jEnRqpAwEdw7S+8l0yVyaNkm66eRI80p+w3AxNbS9hJ/7UlV3lGA==\n-----END RSA PRIVATE KEY----- \n" public_certificate_entry: pem: '-----BEGIN CERTIFICATE----- MIIC7jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3BxETAPBgNVBAoTCEZyYW5rNERE MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBucnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl YiCDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw ODIyMDUyNzQxWhcNMTcwODIxMDUyNzQxWeBKMQswCQYDVQQGEwJKUDEOMAwGA1UE CAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBs ZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0z9FeMynsC8+u dvX+LciZxnh5uRj4C9S6tNeeAlIGCfQYk0zUcNFCoCkTknNQd/YEiawDLNbxBqut bMDZ1aarys1a1lYmUeVLCIqvzBkPJTSQsCopQQ9V8WuT252zzNzs68dVGNdCJd5J NRQykpwexmnjPPv0mvj7i8XgG379TyW6P+WWV5okeUkXJ9eJS2ouDYdR2SM9BoVW +FgxDu6BmXhozW5EfsnajFp7HL8kQClI0QOc79yuKl3492rH6bzFsFn2lfwWy9ic 7cP8EpCTeFp1tFaD+vxBhPZkeTQ1HKx6hQ5zeHIB5ySJJZ7af8W8r4eTGYzbdRW2 4DDHCPhZAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAQMv+BFvGdMVzkQaQ3/+2noVz /uAKbzpEL8xTcxYyP3lkOeh4FoxiSWqy5pGFALdPONoDuYFpLhjJSZaEwuvjI/Tr rGhLV1pRG9frwDFshqD2Vaj4ENBCBh6UpeBop5+285zQ4SI7q4U9oSebUDJiuOx6 +tZ9KynmrbJpTSi0+BM= -----END CERTIFICATE----- ' application/yaml: schema: $ref: '#/components/schemas/Keystore' examples: Keystore: summary: Example of keystore update. value: title: Acme keystore update summary: An example keystore update password: Acme123 private_key_entry: "-----BEGIN RSA PRIVATE KEY-----\nMII7pAIBABKCAQEAtM/RXjMp7AvPrnb1/i3ImcZ4ebkY+AvUurTXngJSBgn0GJNM\n1HDRQqApE5JzUHf2BImsAyzW8QarrWzA2dWmq8rNWtJWJlHlSwiKr8wZDyU0kLAq\nKUEPVfFrk9uds8zc7OvHVRjXQiXeSTUUMpKcHsZp4zz79Jr4+4vF4Bt+/U8luj/l\nlleaJHlJFyfXiUtqLg2HUdkjPQaFVvhYMQ7ugZl4aM1uRH7J2oxaexy/JEApSNED\nnO/cripd+Pdqx+m8xbBZ9pX8FsvYnO3D/BKQk3hadbRWg/r8QYT2ZHk0NRyseoUO\nc3hyAeckiSWe3n9lvK+HkxmM23UVtuAwxwj4WQIDAQABAoIBAE76H0d4La2PEy3v\nhE98DA0vJdx1PzTJZigPacb42H8OxfIeFQcOKDlj381OwNO7MliVEe9pHJG3CjH8\nONhtfBm5wa0UBtFCIFd/6aQUEDYPWECC0kemxV4Sz5yL5vxsVWufKThAW3XnOIrd\nhm74nvzKSeIZ9yvGrU6ipNHY8MUPm0DQVrVYE5MiKjKVExQ4uRAolV2hlmeQDlSt\nk85S0TUOWO1EvJZhsVVs7dBjjY10hIjv3gZPAO8CN75JzMeaNbmWv4RQj0B967in\nrqlOa5qYYt80tAWO4hmPRKCrv6PgThz8C0Cd8AgwNzvQD2d4JpmxxTzBT6/5lRng\nHhj/wQECgYEA2jxC0a4lGmp1q2aYE1Zyiq0UqjxA92pwFYJg3800MLkf96A+dOhd\nwDAc5aAKN8vQV5g33vKi5+pIHWUCskhTS8/PPGrfeqIvtphCj6b7LKosBOhdzrRD\nOsr+Az/SiR2h5l2lr/v7I8I86RTY7MBk4QcRb601kSagWLDNVzSSdhECgYEA1Bm0\n0sByqkQmFoUNRkwmShPfJeVLTCr1G4cllml6MqHmGyRDHxtcp1+CXlyJJemLQY2A\nqrM7/T4x2ta6ME2WgDydFe9M8oU3BbefNYovS6YnoyBqxCx7yZ1vO0Jo40rZI8Bi\nKoCi6e0Hugg4xyPRz9TTNLmr/yEC1qQesMhM9ckCgYEArsT7rfgMdq8zNOSgfTwJ\n1sztc7d1P67ZvCABfLlVRn+6/hAydGVyTus4+RvFkxGB8+RPOhiOJbQVtJSkKCqL\nqnbtu7DK7+ba1xvwkiJjnE1bm0KLfXIXNQpDik6eSHiWo2nzuo/Ne8GeDftIDbG2\nGBAVAp5v+6I3X0+X4nKTqEECgYEAwT4Cj5mjXxnkEdR7eahHwmpEf0RfzC+/Tate\nRXZsrUDwY34wYWEOk7fjEZIBqrcTl1ATEHNojpxh096bmHK4UnHnNRrn4nYY4W6g\n8ajK2oOxzWA1pjJZPiHgO/+PjLafC4G2br7wr2y0A3yGLnmmKVLgc0NPP42WBnVV\nOP/ljnECgYABlDdJCAehDNSv4mdEzY5bfD+VBFd2QsgE1hYhmUYYRNlgIfIL9Y8e\nCduqXFLNZ/LHdmtYembgUqrMiJTUqcbSrJt26kBQx0az3LAV+J2p68PQ85KR9ZPy\nN1jEnRqpAwEdw7S+8l0yVyaNkm66eRI80p+w3AxNbS9hJ/7UlV3lGA==\n-----END RSA PRIVATE KEY----- \n" public_certificate_entry: pem: '-----BEGIN CERTIFICATE----- MIIC7jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3BxETAPBgNVBAoTCEZyYW5rNERE MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBucnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl YiCDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw ODIyMDUyNzQxWhcNMTcwODIxMDUyNzQxWeBKMQswCQYDVQQGEwJKUDEOMAwGA1UE CAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBs ZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0z9FeMynsC8+u dvX+LciZxnh5uRj4C9S6tNeeAlIGCfQYk0zUcNFCoCkTknNQd/YEiawDLNbxBqut bMDZ1aarys1a1lYmUeVLCIqvzBkPJTSQsCopQQ9V8WuT252zzNzs68dVGNdCJd5J NRQykpwexmnjPPv0mvj7i8XgG379TyW6P+WWV5okeUkXJ9eJS2ouDYdR2SM9BoVW +FgxDu6BmXhozW5EfsnajFp7HL8kQClI0QOc79yuKl3492rH6bzFsFn2lfwWy9ic 7cP8EpCTeFp1tFaD+vxBhPZkeTQ1HKx6hQ5zeHIB5ySJJZ7af8W8r4eTGYzbdRW2 4DDHCPhZAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAQMv+BFvGdMVzkQaQ3/+2noVz /uAKbzpEL8xTcxYyP3lkOeh4FoxiSWqy5pGFALdPONoDuYFpLhjJSZaEwuvjI/Tr rGhLV1pRG9frwDFshqD2Vaj4ENBCBh6UpeBop5+285zQ4SI7q4U9oSebUDJiuOx6 +tZ9KynmrbJpTSi0+BM= -----END CERTIFICATE----- ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Keystore' application/yaml: schema: $ref: '#/components/schemas/Keystore' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Deletes a keystore description: Deletes a keystore belonging to a provider organization. operationId: keystore_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Keystore' application/yaml: schema: $ref: '#/components/schemas/Keystore' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/truststores: description: The collection of Truststore operations parameters: - $ref: '#/components/parameters/org' post: summary: Creates a trust store description: 'Creates a trust store. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: truststore_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Truststore' examples: Truststore: summary: Example truststore create. value: summary: An example truststore create name: acme-truststore title: ACME Truststore truststore: '-----BEGIN CERTIFICATE----- MIIC2jCCAkMCAg38MA0HCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMaWg A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNere MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVbamTD0ZyYW5rNEREIFdl YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazrKzC5jb20wHhcNMTIw ODIyMDUyNzQxWhcNMTcwODIxMDUyNzQxWjBKMQswCQYdvqQGEwJKUDEOMAwGA1UE CAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA94e4cuZXhhbxBs ZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0z9FeMynsC8+u dvX+LciZxnh5uRj4C9S6tNeeAlIGCfQYk0zUcNFCoCkTknNQd/YEiawDLNbxBqut bMDZ1aarys1a0lYmUeVLCIqvzBkPJTSQsCopQQ9V8WuT252zzNzs68dVGNdCJd5J NRQykpwexmnlOOv0mvj7i8XgG379TyW6P+WWV5okeUkXJ9eJS2ouDYdR2SM9BoVW +FgxDu6BmXhozW5EfsnajFp7HL8kQClI0QOc79yuKl3492rH6bzFsFn2lfwWy9ic 7cP8EpCTeFp1tFaD+vxBhPZkeTQ1HKx6hQ5zeHIB5ySJJZ7af2W8r4eTGYzbdRW2 4DDHCPhZAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAQMv+BFvGdMVzkQaQ3/+2noVz /uAKbzpEL8xTcxYyP3lkOeh4FoxiSWqy5pGFALdPONoDuYFpLhjJSZaEwuvjI/Tr rGhLV1pRG9frwDFshqD2Vaj4ENBCBh6UpeBop5+285zQ4SI7q4U9oSebUDJiuOx6 +tZ9KynmrbJpTSi0+BM= -----END CERTIFICATE----- ' application/yaml: schema: $ref: '#/components/schemas/Truststore' examples: Truststore: summary: Example truststore create. value: summary: An example truststore create name: acme-truststore title: ACME Truststore truststore: '-----BEGIN CERTIFICATE----- MIIC2jCCAkMCAg38MA0HCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMaWg A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNere MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVbamTD0ZyYW5rNEREIFdl YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazrKzC5jb20wHhcNMTIw ODIyMDUyNzQxWhcNMTcwODIxMDUyNzQxWjBKMQswCQYdvqQGEwJKUDEOMAwGA1UE CAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA94e4cuZXhhbxBs ZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0z9FeMynsC8+u dvX+LciZxnh5uRj4C9S6tNeeAlIGCfQYk0zUcNFCoCkTknNQd/YEiawDLNbxBqut bMDZ1aarys1a0lYmUeVLCIqvzBkPJTSQsCopQQ9V8WuT252zzNzs68dVGNdCJd5J NRQykpwexmnlOOv0mvj7i8XgG379TyW6P+WWV5okeUkXJ9eJS2ouDYdR2SM9BoVW +FgxDu6BmXhozW5EfsnajFp7HL8kQClI0QOc79yuKl3492rH6bzFsFn2lfwWy9ic 7cP8EpCTeFp1tFaD+vxBhPZkeTQ1HKx6hQ5zeHIB5ySJJZ7af2W8r4eTGYzbdRW2 4DDHCPhZAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAQMv+BFvGdMVzkQaQ3/+2noVz /uAKbzpEL8xTcxYyP3lkOeh4FoxiSWqy5pGFALdPONoDuYFpLhjJSZaEwuvjI/Tr rGhLV1pRG9frwDFshqD2Vaj4ENBCBh6UpeBop5+285zQ4SI7q4U9oSebUDJiuOx6 +tZ9KynmrbJpTSi0+BM= -----END CERTIFICATE----- ' responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Truststore' application/yaml: schema: $ref: '#/components/schemas/Truststore' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: Lists trust stores description: Returns the list of all trust stores belonging to a provider organization. operationId: truststore_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TruststoreList' application/yaml: schema: $ref: '#/components/schemas/TruststoreList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clears trust stores description: Removes all trust stores belonging to a provider organization. operationId: truststore_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/truststores/{truststore}: description: Truststore object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/truststore' get: summary: Returns a trust store description: Returns a trust store. operationId: truststore_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Truststore' application/yaml: schema: $ref: '#/components/schemas/Truststore' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Updates a trust store description: 'Updates a trust store. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: truststore_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Truststore' examples: Truststore: summary: Example truststore update. value: summary: An example truststore update title: ACME Truststore application/yaml: schema: $ref: '#/components/schemas/Truststore' examples: Truststore: summary: Example truststore update. value: summary: An example truststore update title: ACME Truststore responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Truststore' application/yaml: schema: $ref: '#/components/schemas/Truststore' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Deletes a trust store description: Deletes a trust store. operationId: truststore_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Truststore' application/yaml: schema: $ref: '#/components/schemas/Truststore' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/truststores/{truststore}/entries: description: The collection of Entry operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/truststore' post: summary: Creates a trust store entry description: 'Adds an entry to a trust store. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: entry_createTruststoreScope security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Entry' application/yaml: schema: $ref: '#/components/schemas/Entry' responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Entry' application/yaml: schema: $ref: '#/components/schemas/Entry' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: Lists trust store entries description: Returns the list of entries from a trust store. operationId: entry_listTruststoreScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EntryList' application/yaml: schema: $ref: '#/components/schemas/EntryList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clears trust store entries description: Deletes all entries from a trust store. operationId: entry_clearTruststoreScope security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/truststores/{truststore}/entries/{entry}: description: Entry object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/truststore' - $ref: '#/components/parameters/entry' get: summary: Returns a trust store entry description: Returns the given entry from a trust store. operationId: entry_getTruststoreScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Entry' application/yaml: schema: $ref: '#/components/schemas/Entry' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Updates a trust store entry description: 'Updates the given entry in a trust store. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: entry_updateTruststoreScope security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Entry' application/yaml: schema: $ref: '#/components/schemas/Entry' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Entry' application/yaml: schema: $ref: '#/components/schemas/Entry' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Deletes a trust store entry description: Deletes the given entry from a trust store. operationId: entry_delTruststoreScope security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Entry' application/yaml: schema: $ref: '#/components/schemas/Entry' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/jwk-sets: description: The collection of Jwk Set operations parameters: - $ref: '#/components/parameters/org' post: summary: Create a Jwk Set object description: 'Create a Jwk Set object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: jwk_set_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/JwkSet' examples: JwkSet: summary: Example of creating a JWK set containing a private and public key value: title: acme-jwkset keys: - kty: RSA n: s6-7fcj1M4c1fjoo1ZSyDfCxJ6C54jOJ3_u95CSa77AS6t8cTSRXrriyh9rd-mpxZaYlhZlsfoi286k5c8AcQRDv6Qu_IIv8FgoQEQNyTAWzspFsVoWNyF923V3vFfbgZuqdiOxODgAaEyjBWjOZ1yQTdQwT09g3aQSmS2UOsBGOI8mIPlnK_tZ6p4SxIC2kg_K8WeIoA8taT9CNfrOPHgJhG6kgcg5YOlpu9By5AqvZVALNPK4lAThwOfvrDG92MVekDRqGG4hUNaO4JhnV8eJz2cp1Qc3pKSJsDdubRY_mH6bd6FfG6LsAhkEvsmQYIE0T24pcZyti4mRf9-mqmQ e: AQAB d: CFpObmn1kAgkgfIlLMyFPGWobo2npm675YgXyy-ybhryvi1R7PoYA1y9m9geQoJJNC71hpDbvMQRMSF4NLvE9Hdbl6s-nr4zITklhwzwdr07Hb1p2lnJ_fsGFQNFVnGL--zDFvbZKAh0LdjSqCVG7PvV1baSg2IFLWIUcuPHO4L5RPueeSIXmDbLMZOt4hjetdn4B6zoiXfdaNOHrjfe-uZOVzywqjs7UdwlKiwgQ9eZACRkatnCBaPJGHheNjd6g9pT3HZxA6zmA_CZ3AGdneEg2g6pBWS94mMFQrgkFvjnrZHn9jO7FobVMrqaBWufBSPnAR86vSu3Hep-KBngUw p: 9nQtcWJt89_NT2xXg5ebo-uYFdVdGSCAdHjZkdWR0QWa4g8fMTEgBgPWZe-h3zzQoBm8AuoZZB6T9QKea9w0YAX-nesAkA0KgUoeaD4t-NhI12Il1irpAJTBdLreltE54M1Ca-SE4s6qpm9kJ8PIprxtdKeGMc5kRu0A0FBsGL8 q: uqV-TdYImgwN4eISix7hV_f3VgEEQ1VfaV-65oGMh3PZCzV1kLm75fk32_NFaY1mLokbQeDJ3yUgiHi-iYRfKItS_22pZ1zGCEsN1k3lFr7ePrcgmjYMK2pUTpyxEc5Knzn5be4rb2dAvBsqccReps_RUxG2SA7YT7Xk9mqF-qc dp: KORZ7ehBCifmLvlxA9qR7n7Wuzitu8-SwMCUiQgAq8fcTQnpSQY3pAfa-QrrttimXQooEeu5zszsC8kldAwTfKNB_f3SGBSx24Xqya0Xf6STYXldgc2Y34nPF4kyCaAplE06aiB-lAtqcTcmTRrFHjVBjAuHzpfKN6J3chkF9o0 dq: iH_pnBEQ32A7ctv8BcSCtuwA9ePuczPngE_jhxptZM5jiCADp-E9upWFtZT3SZeAiD37MjWsTUaAwW3Uowus8CDchTN09cPSjFQffYAgL39NV_5jmIQ4aDPuDkPn94av6jzi3vOUzndrz2Xqp6MeOc64XpEQhyhcKAd1uIT1EPc qi: ns5ITFsJs9uKCJTeeUrbplxK9CB3NKqJAQP7JIHaqHf0Ryz1SrUKCDpu3N-FlYMOQ8U_rtmNTAngy6s3SQ15GaOnwlI1e2howNAF0G0zo4o2flxLlSUtnxsKSvM3-K6JyX6bw2S6aZkS0Y04U6RH1xPDWTRCd09MKYjD5AGjgvg kid: b449971a-2d70-4a60-8171-8f84d71536a3 - kty: RSA n: s6-7fcj1M4c1fjoo1ZSyDfCxJ6C54jOJ3_u95CSa77AS6t8cTSRXrriyh9rd-mpxZaYlhZlsfoi286k5c8AcQRDv6Qu_IIv8FgoQEQNyTAWzspFsVoWNyF923V3vFfbgZuqdiOxODgAaEyjBWjOZ1yQTdQwT09g3aQSmS2UOsBGOI8mIPlnK_tZ6p4SxIC2kg_K8WeIoA8taT9CNfrOPHgJhG6kgcg5YOlpu9By5AqvZVALNPK4lAThwOfvrDG92MVekDRqGG4hUNaO4JhnV8eJz2cp1Qc3pKSJsDdubRY_mH6bd6FfG6LsAhkEvsmQYIE0T24pcZyti4mRf9-mqmQ e: AQAB kid: b449971a-2d70-4a60-8171-8f84d71536a3 application/yaml: schema: $ref: '#/components/schemas/JwkSet' examples: JwkSet: summary: Example of creating a JWK set containing a private and public key value: title: acme-jwkset keys: - kty: RSA n: s6-7fcj1M4c1fjoo1ZSyDfCxJ6C54jOJ3_u95CSa77AS6t8cTSRXrriyh9rd-mpxZaYlhZlsfoi286k5c8AcQRDv6Qu_IIv8FgoQEQNyTAWzspFsVoWNyF923V3vFfbgZuqdiOxODgAaEyjBWjOZ1yQTdQwT09g3aQSmS2UOsBGOI8mIPlnK_tZ6p4SxIC2kg_K8WeIoA8taT9CNfrOPHgJhG6kgcg5YOlpu9By5AqvZVALNPK4lAThwOfvrDG92MVekDRqGG4hUNaO4JhnV8eJz2cp1Qc3pKSJsDdubRY_mH6bd6FfG6LsAhkEvsmQYIE0T24pcZyti4mRf9-mqmQ e: AQAB d: CFpObmn1kAgkgfIlLMyFPGWobo2npm675YgXyy-ybhryvi1R7PoYA1y9m9geQoJJNC71hpDbvMQRMSF4NLvE9Hdbl6s-nr4zITklhwzwdr07Hb1p2lnJ_fsGFQNFVnGL--zDFvbZKAh0LdjSqCVG7PvV1baSg2IFLWIUcuPHO4L5RPueeSIXmDbLMZOt4hjetdn4B6zoiXfdaNOHrjfe-uZOVzywqjs7UdwlKiwgQ9eZACRkatnCBaPJGHheNjd6g9pT3HZxA6zmA_CZ3AGdneEg2g6pBWS94mMFQrgkFvjnrZHn9jO7FobVMrqaBWufBSPnAR86vSu3Hep-KBngUw p: 9nQtcWJt89_NT2xXg5ebo-uYFdVdGSCAdHjZkdWR0QWa4g8fMTEgBgPWZe-h3zzQoBm8AuoZZB6T9QKea9w0YAX-nesAkA0KgUoeaD4t-NhI12Il1irpAJTBdLreltE54M1Ca-SE4s6qpm9kJ8PIprxtdKeGMc5kRu0A0FBsGL8 q: uqV-TdYImgwN4eISix7hV_f3VgEEQ1VfaV-65oGMh3PZCzV1kLm75fk32_NFaY1mLokbQeDJ3yUgiHi-iYRfKItS_22pZ1zGCEsN1k3lFr7ePrcgmjYMK2pUTpyxEc5Knzn5be4rb2dAvBsqccReps_RUxG2SA7YT7Xk9mqF-qc dp: KORZ7ehBCifmLvlxA9qR7n7Wuzitu8-SwMCUiQgAq8fcTQnpSQY3pAfa-QrrttimXQooEeu5zszsC8kldAwTfKNB_f3SGBSx24Xqya0Xf6STYXldgc2Y34nPF4kyCaAplE06aiB-lAtqcTcmTRrFHjVBjAuHzpfKN6J3chkF9o0 dq: iH_pnBEQ32A7ctv8BcSCtuwA9ePuczPngE_jhxptZM5jiCADp-E9upWFtZT3SZeAiD37MjWsTUaAwW3Uowus8CDchTN09cPSjFQffYAgL39NV_5jmIQ4aDPuDkPn94av6jzi3vOUzndrz2Xqp6MeOc64XpEQhyhcKAd1uIT1EPc qi: ns5ITFsJs9uKCJTeeUrbplxK9CB3NKqJAQP7JIHaqHf0Ryz1SrUKCDpu3N-FlYMOQ8U_rtmNTAngy6s3SQ15GaOnwlI1e2howNAF0G0zo4o2flxLlSUtnxsKSvM3-K6JyX6bw2S6aZkS0Y04U6RH1xPDWTRCd09MKYjD5AGjgvg kid: b449971a-2d70-4a60-8171-8f84d71536a3 - kty: RSA n: s6-7fcj1M4c1fjoo1ZSyDfCxJ6C54jOJ3_u95CSa77AS6t8cTSRXrriyh9rd-mpxZaYlhZlsfoi286k5c8AcQRDv6Qu_IIv8FgoQEQNyTAWzspFsVoWNyF923V3vFfbgZuqdiOxODgAaEyjBWjOZ1yQTdQwT09g3aQSmS2UOsBGOI8mIPlnK_tZ6p4SxIC2kg_K8WeIoA8taT9CNfrOPHgJhG6kgcg5YOlpu9By5AqvZVALNPK4lAThwOfvrDG92MVekDRqGG4hUNaO4JhnV8eJz2cp1Qc3pKSJsDdubRY_mH6bd6FfG6LsAhkEvsmQYIE0T24pcZyti4mRf9-mqmQ e: AQAB kid: b449971a-2d70-4a60-8171-8f84d71536a3 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/JwkSet' application/yaml: schema: $ref: '#/components/schemas/JwkSet' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Jwk Set objects operationId: jwk_set_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/JwkSetList' application/yaml: schema: $ref: '#/components/schemas/JwkSetList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Jwk Set objects operationId: jwk_set_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/jwk-sets/{jwk-set}: description: Jwk Set object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/jwk-set' get: summary: Get the Jwk Set object by name or id operationId: jwk_set_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/JwkSet' application/yaml: schema: $ref: '#/components/schemas/JwkSet' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Jwk Set object by name or id operationId: jwk_set_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/JwkSet' application/yaml: schema: $ref: '#/components/schemas/JwkSet' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/jwk-sets/generate: parameters: - $ref: '#/components/parameters/org' post: summary: Generate a Jwk Set operationId: jwk_set_generate security: - oauth: - org:manage responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/JwkSet' application/yaml: schema: $ref: '#/components/schemas/JwkSet' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases: description: Alias operations across all collections parameters: - $ref: '#/components/parameters/org' get: summary: List all Alias objects in all collections operationId: alias_listAll security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AliasList' application/yaml: schema: $ref: '#/components/schemas/AliasList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear all Alias objects in all collections operationId: alias_clearAll security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/xslt-transformations: description: Xslt Transformation Alias operations across all collections parameters: - $ref: '#/components/parameters/org' post: summary: Create a Xslt Transformation Alias object description: 'Create a Xslt Transformation Alias object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: xslt_transformation_alias_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' examples: XsltTransformationAlias: summary: Example for XSLT transformation alias create value: name: acme-xslt-alias title: ACME XSLT Transformation Alias summary: Example XSLT transformation alias for ACME org xsl_file: xslt-transformation-aliases/acme-transform.xsl application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' examples: XsltTransformationAlias: summary: Example for XSLT transformation alias create value: name: acme-xslt-alias title: ACME XSLT Transformation Alias summary: Example XSLT transformation alias for ACME org xsl_file: xslt-transformation-aliases/acme-transform.xsl multipart/form-data: schema: $ref: '#/components/schemas/XsltTransformationAliasMultipart' responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List all Xslt Transformation Alias objects in all collections operationId: xslt_transformation_alias_listAll security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAliasList' application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAliasList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear all Xslt Transformation Alias objects in all collections operationId: xslt_transformation_alias_clearAll security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-name}: description: The collection of Xslt Transformation Alias operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/xslt-transformation-alias-name' get: summary: List the Xslt Transformation Alias objects operationId: xslt_transformation_alias_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAliasList' application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAliasList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Xslt Transformation Alias objects operationId: xslt_transformation_alias_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-id}: description: Xslt Transformation Alias object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/xslt-transformation-alias-id' get: summary: Get the Xslt Transformation Alias object by id operationId: xslt_transformation_alias_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Xslt Transformation Alias object by id description: 'Update the Xslt Transformation Alias object by id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: xslt_transformation_alias_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' examples: XsltTransformationAlias: summary: Example for XSLT transformation alias update value: title: ACME XSLT Transformation Alias summary: Updated XSLT transformation alias for ACME org xsl_file: xslt-transformation-aliases/acme-transform.xsl application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' examples: XsltTransformationAlias: summary: Example for XSLT transformation alias update value: title: ACME XSLT Transformation Alias summary: Updated XSLT transformation alias for ACME org xsl_file: xslt-transformation-aliases/acme-transform.xsl multipart/form-data: schema: $ref: '#/components/schemas/XsltTransformationAliasMultipart' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Xslt Transformation Alias object by id operationId: xslt_transformation_alias_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-name}/{xslt-transformation-alias-version}: description: Xslt Transformation Alias object operations by name and version parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/xslt-transformation-alias-name' - $ref: '#/components/parameters/xslt-transformation-alias-version' get: summary: Get the Xslt Transformation Alias object by name and version operationId: xslt_transformation_alias_getByNameVersion security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Xslt Transformation Alias object by name and version description: 'Update the Xslt Transformation Alias object by name and version Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: xslt_transformation_alias_updateByNameVersion security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' examples: XsltTransformationAlias: summary: Example for XSLT transformation alias update by name and version value: name: acme-xslt-alias title: ACME XSLT Transformation Alias summary: Updated XSLT transformation alias for ACME org xsl_file: xslt-transformation-aliases/acme-transform.xsl application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' examples: XsltTransformationAlias: summary: Example for XSLT transformation alias update by name and version value: name: acme-xslt-alias title: ACME XSLT Transformation Alias summary: Updated XSLT transformation alias for ACME org xsl_file: xslt-transformation-aliases/acme-transform.xsl multipart/form-data: schema: $ref: '#/components/schemas/XsltTransformationAliasMultipart' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete a Xslt Transformation Alias operationId: xslt_transformation_alias_delByNameVersion security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/XsltTransformationAlias' application/yaml: schema: $ref: '#/components/schemas/XsltTransformationAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/http-transport-securities: description: Http Transport Security Alias operations across all collections parameters: - $ref: '#/components/parameters/org' post: summary: Create a Http Transport Security Alias object description: 'Create a Http Transport Security Alias object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: http_transport_security_alias_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List all Http Transport Security Alias objects in all collections operationId: http_transport_security_alias_listAll security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAliasList' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAliasList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear all Http Transport Security Alias objects in all collections operationId: http_transport_security_alias_clearAll security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-name}: description: The collection of Http Transport Security Alias operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/http-transport-security-alias-name' get: summary: List the Http Transport Security Alias objects operationId: http_transport_security_alias_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAliasList' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAliasList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Http Transport Security Alias objects operationId: http_transport_security_alias_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-id}: description: Http Transport Security Alias object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/http-transport-security-alias-id' get: summary: Get the Http Transport Security Alias object by id operationId: http_transport_security_alias_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Http Transport Security Alias object by id description: 'Update the Http Transport Security Alias object by id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: http_transport_security_alias_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Http Transport Security Alias object by id operationId: http_transport_security_alias_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-name}/{http-transport-security-alias-version}: description: Http Transport Security Alias object operations by name and version parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/http-transport-security-alias-name' - $ref: '#/components/parameters/http-transport-security-alias-version' get: summary: Get the Http Transport Security Alias object by name and version operationId: http_transport_security_alias_getByNameVersion security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Http Transport Security Alias object by name and version description: 'Update the Http Transport Security Alias object by name and version Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: http_transport_security_alias_updateByNameVersion security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete a Http Transport Security Alias operationId: http_transport_security_alias_delByNameVersion security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' application/yaml: schema: $ref: '#/components/schemas/HttpTransportSecurityAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/webmethods-is-services: description: Webmethods Integration Server Service Alias operations across all collections parameters: - $ref: '#/components/parameters/org' post: summary: Create a Webmethods Integration Server Service Alias object description: 'Create a Webmethods Integration Server Service Alias object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: webmethods_is_service_alias_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List all Webmethods Integration Server Service Alias objects in all collections operationId: webmethods_is_service_alias_listAll security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAliasList' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAliasList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear all Webmethods Integration Server Service Alias objects in all collections operationId: webmethods_is_service_alias_clearAll security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-name}: description: The collection of Webmethods Integration Server Service Alias operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/webmethods-is-service-alias-name' get: summary: List the Webmethods Integration Server Service Alias objects operationId: webmethods_is_service_alias_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAliasList' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAliasList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Webmethods Integration Server Service Alias objects operationId: webmethods_is_service_alias_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-id}: description: Webmethods Integration Server Service Alias object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/webmethods-is-service-alias-id' get: summary: Get the Webmethods Integration Server Service Alias object by id operationId: webmethods_is_service_alias_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Webmethods Integration Server Service Alias object by id description: 'Update the Webmethods Integration Server Service Alias object by id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: webmethods_is_service_alias_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Webmethods Integration Server Service Alias object by id operationId: webmethods_is_service_alias_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-name}/{webmethods-is-service-alias-version}: description: Webmethods Integration Server Service Alias object operations by name and version parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/webmethods-is-service-alias-name' - $ref: '#/components/parameters/webmethods-is-service-alias-version' get: summary: Get the Webmethods Integration Server Service Alias object by name and version operationId: webmethods_is_service_alias_getByNameVersion security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Webmethods Integration Server Service Alias object by name and… description: 'Update the Webmethods Integration Server Service Alias object by name and version Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: webmethods_is_service_alias_updateByNameVersion security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete a Webmethods Integration Server Service Alias operationId: webmethods_is_service_alias_delByNameVersion security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' application/yaml: schema: $ref: '#/components/schemas/WebmethodsIsServiceAlias' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/watsonx-settings: description: The collection of Watsonx Settings operations parameters: - $ref: '#/components/parameters/org' post: summary: Create a Watsonx Settings object description: 'Create a Watsonx Settings object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: watsonx_settings_createOrgScope security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/WatsonxSettings' application/yaml: schema: $ref: '#/components/schemas/WatsonxSettings' responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/WatsonxSettings' application/yaml: schema: $ref: '#/components/schemas/WatsonxSettings' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Watsonx Settings objects operationId: watsonx_settings_listOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WatsonxSettingsList' application/yaml: schema: $ref: '#/components/schemas/WatsonxSettingsList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/watsonx-settings/{watsonx-settings}: description: Watsonx Settings object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/watsonx-settings' get: summary: Get the Watsonx Settings object by name or id operationId: watsonx_settings_getOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WatsonxSettings' application/yaml: schema: $ref: '#/components/schemas/WatsonxSettings' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Watsonx Settings object by name or id description: 'Update the Watsonx Settings object by name or id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: watsonx_settings_updateOrgScope security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/WatsonxSettings' application/yaml: schema: $ref: '#/components/schemas/WatsonxSettings' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WatsonxSettings' application/yaml: schema: $ref: '#/components/schemas/WatsonxSettings' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Watsonx Settings object by name or id operationId: watsonx_settings_delOrgScope security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/WatsonxSettings' application/yaml: schema: $ref: '#/components/schemas/WatsonxSettings' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/watsonx-settings/test-connection: parameters: - $ref: '#/components/parameters/org' post: summary: Test a WatsonX connection operationId: watsonx_settings_testConnection security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/WatsonxSettingsTestConnection' application/yaml: schema: $ref: '#/components/schemas/WatsonxSettingsTestConnection' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WatsonxSettingsTestConnectionResponse' application/yaml: schema: $ref: '#/components/schemas/WatsonxSettingsTestConnectionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /billings: description: The collection of Billing operations get: summary: List the Billing objects operationId: billing_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BillingList' application/yaml: schema: $ref: '#/components/schemas/BillingList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: Consumer apim base path /billings/{billing}: description: Billing object operations parameters: - $ref: '#/components/parameters/billing' get: summary: Get the Billing object by name or id operationId: billing_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Billing' application/yaml: schema: $ref: '#/components/schemas/Billing' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: Consumer apim base path /orgs/{org}/gateway-services: description: The collection of Gateway Service operations parameters: - $ref: '#/components/parameters/org' get: summary: Lists gateway services description: Returns the list of gateway services. operationId: gateway_service_listOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayServiceList' application/yaml: schema: $ref: '#/components/schemas/GatewayServiceList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/gateway-services/{gateway-service}: description: Gateway Service object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/gateway-service' get: summary: Returns a gateway service description: Returns the given gateway service. operationId: gateway_service_getOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayService' application/yaml: schema: $ref: '#/components/schemas/GatewayService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/portal-services: description: The collection of Portal Service operations parameters: - $ref: '#/components/parameters/org' get: summary: Lists portal services description: Returns the list of portal services belonging to a provider orgsnization. operationId: portal_service_listOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PortalServiceList' application/yaml: schema: $ref: '#/components/schemas/PortalServiceList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/portal-services/{portal-service}: description: Portal Service object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/portal-service' get: summary: Returns a portal service description: Returns a portal service belonging to a provider orgsnization. operationId: portal_service_getOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PortalService' application/yaml: schema: $ref: '#/components/schemas/PortalService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/billings: description: The collection of Billing operations parameters: - $ref: '#/components/parameters/org' post: summary: Create a Billing object description: 'Create a Billing object Required fields: - integration_url Fields not allowed: - job_queue_status Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: billing_create security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Billing_2' examples: Billing: summary: Example of billing creation value: title: Acme billing name: acme-billing summary: An example billing creation integration_url: https://acme-apim.example.com/api/cloud/integrations/billing/stripe configuration: full_access_key: pqhcnmweryunauenosswo publishable_key: yuqtunsdgoqwtyiofghnj application/yaml: schema: $ref: '#/components/schemas/Billing_2' examples: Billing: summary: Example of billing creation value: title: Acme billing name: acme-billing summary: An example billing creation integration_url: https://acme-apim.example.com/api/cloud/integrations/billing/stripe configuration: full_access_key: pqhcnmweryunauenosswo publishable_key: yuqtunsdgoqwtyiofghnj responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Billing_2' application/yaml: schema: $ref: '#/components/schemas/Billing_2' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List the Billing objects operationId: getOrgsByOrgBillings security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BillingList' application/yaml: schema: $ref: '#/components/schemas/BillingList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources x-operation-id-source: normalized x-operation-id-original: billing_list delete: summary: Clear the Billing objects operationId: billing_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/billings/{billing}: description: Billing object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/billing' get: summary: Get the Billing object by name or id operationId: getOrgsByOrgBillingsByBilling security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Billing_2' application/yaml: schema: $ref: '#/components/schemas/Billing_2' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources x-operation-id-source: normalized x-operation-id-original: billing_get patch: summary: Update the Billing object by name or id description: 'Update the Billing object by name or id Fields not allowed to be null: - integration_url Fields not allowed: - job_queue_status Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: billing_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Billing_2' application/yaml: schema: $ref: '#/components/schemas/Billing_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Billing_2' application/yaml: schema: $ref: '#/components/schemas/Billing_2' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Billing object by name or id operationId: billing_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Billing_2' application/yaml: schema: $ref: '#/components/schemas/Billing_2' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/billings/{billing}/jobs: description: The collection of Job operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/billing' get: summary: List the Job objects operationId: job_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/JobList' application/yaml: schema: $ref: '#/components/schemas/JobList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Job objects operationId: job_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/billings/{billing}/jobs/{job}: description: Job object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/billing' - $ref: '#/components/parameters/job' get: summary: Get the Job object by name or id operationId: job_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Job' application/yaml: schema: $ref: '#/components/schemas/Job' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Job object by name or id operationId: job_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Job' application/yaml: schema: $ref: '#/components/schemas/Job' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/billings/{billing}/jobs/{job}/retry: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/billing' - $ref: '#/components/parameters/job' post: summary: Re-attempt blocked or failed job operationId: job_retry security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '200': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/analytics-services: description: The collection of Analytics Service operations parameters: - $ref: '#/components/parameters/org' get: summary: List the Analytics Service objects operationId: analytics_service_listOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AnalyticsServiceList' application/yaml: schema: $ref: '#/components/schemas/AnalyticsServiceList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/analytics-services/{analytics-service}: description: Analytics Service object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/analytics-service' get: summary: Get the Analytics Service object by name or id operationId: analytics_service_getOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AnalyticsService' application/yaml: schema: $ref: '#/components/schemas/AnalyticsService' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/programming-packages: description: Programming Package operations across all collections parameters: - $ref: '#/components/parameters/org' post: summary: Create a Programming Package object description: 'Create a Programming Package object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: programming_package_create security: - oauth: - org:manage requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/ProgrammingPackageMultipart' examples: ProgrammingPackage: summary: Example for programming package create value: name: acme-programming-package version: 1.0.0 title: ACME Programming Package summary: Example programming package for ACME org programming_package_type: lua programming_package_files: - file_path: programming-packages/acme-module.lua mimetype: text/x-lua responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackage' application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackage' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources get: summary: List all Programming Package objects in all collections operationId: programming_package_listAll security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackageList' application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackageList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear all Programming Package objects in all collections operationId: programming_package_clearAll security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' - $ref: '#/components/parameters/cascade' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/programming-packages/{programming-package-name}: description: The collection of Programming Package operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/programming-package-name' get: summary: List the Programming Package objects operationId: programming_package_list security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackageList' application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackageList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Clear the Programming Package objects operationId: programming_package_clear security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/programming-packages/{programming-package-id}: description: Programming Package object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/programming-package-id' get: summary: Get the Programming Package object by id operationId: programming_package_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackage' application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackage' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Programming Package object by id description: 'Update the Programming Package object by id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: programming_package_update security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackage' examples: ProgrammingPackage: summary: Example for programming package update value: title: ACME Programming Package summary: Updated programming package for ACME org programming_package_type: lua programming_package_files: - file_path: programming-packages/acme-module.lua mimetype: text/x-lua application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackage' examples: ProgrammingPackage: summary: Example for programming package update value: title: ACME Programming Package summary: Updated programming package for ACME org programming_package_type: lua programming_package_files: - file_path: programming-packages/acme-module.lua mimetype: text/x-lua multipart/form-data: schema: $ref: '#/components/schemas/ProgrammingPackageMultipart' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackage' application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackage' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete the Programming Package object by id operationId: programming_package_del security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackage' application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackage' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path /orgs/{org}/programming-packages/{programming-package-name}/{programming-package-version}: description: Programming Package object operations by name and version parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/programming-package-name' - $ref: '#/components/parameters/programming-package-version' get: summary: Get the Programming Package object by name and version operationId: programming_package_getByNameVersion security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackage' application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackage' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources patch: summary: Update the Programming Package object by name and version description: 'Update the Programming Package object by name and version Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url' operationId: programming_package_updateByNameVersion security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackage' examples: ProgrammingPackage: summary: Example for programming package update by name and version value: name: acme-programming-package version: 1.0.0 title: ACME Programming Package summary: Updated programming package for ACME org programming_package_type: lua programming_package_files: - file_path: programming-packages/acme-module.lua mimetype: text/x-lua application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackage' examples: ProgrammingPackage: summary: Example for programming package update by name and version value: name: acme-programming-package version: 1.0.0 title: ACME Programming Package summary: Updated programming package for ACME org programming_package_type: lua programming_package_files: - file_path: programming-packages/acme-module.lua mimetype: text/x-lua multipart/form-data: schema: $ref: '#/components/schemas/ProgrammingPackageMultipart' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackage' application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackage' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources delete: summary: Delete a Programming Package operationId: programming_package_delByNameVersion security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/ProgrammingPackage' application/yaml: schema: $ref: '#/components/schemas/ProgrammingPackage' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Organization Resources servers: - url: '' description: APIM base path components: schemas: ProjectErrorProcessing: description: The Conditional Error Handling related information is captured in the message ConditionalErrorProcessing. type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - ErrorProcessing type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: description: Can be enabled or disabled type: boolean condition: description: Single instance of condition can be given type: string pre-processing: description: 'Field ''pre_processing'' with JSON name ''pre-processing'' accepts the value of either ''pre_processing'' or ''pre-processing'' from the YAML file. If both ''pre_processing'' and ''pre-processing'' are specified, the value of ''pre-processing'' takes priority. Multiple instances of pre processing can be given with JSON name "pre-processing".' type: object additionalProperties: false properties: webMethodsISService: $ref: '#/components/schemas/ProjectReferenceList' xsl: $ref: '#/components/schemas/ProjectXslSchema' transformations: $ref: '#/components/schemas/ProjectErrorProcessingTransformationsSchema' post-processing: description: 'Field ''post_processing'' with JSON name ''post-processing'' accepts the value of either ''post_processing'' or ''post-processing'' from the YAML file. If both ''post_processing'' and ''post-processing'' are specified, the value of ''post-processing'' takes priority. Multiple instances of post processing can be given with JSON name ''post-processing".' type: object additionalProperties: false properties: webMethodsISService: $ref: '#/components/schemas/ProjectReferenceList' xsl: $ref: '#/components/schemas/ProjectXslSchema' SubscriberProcessingStatus: type: object additionalProperties: false properties: service_state: type: string enum: - green - orange - red service_up_to_date: type: boolean last_processed_event: type: object properties: event_id: type: string title: type: string filter: type: string generated_at: type: string processed_at: type: string event_processing_time: type: integer elapsed_time_since_last_processed_event: type: integer first_failed_event: $ref: '#/components/schemas/SubscriberEventStatus' number_of_outstanding_sent_events: type: integer minimum: 0 maximum: 2147483647 last_sent_event: type: object properties: event_id: type: string title: type: string sent_at: type: string generated_at: type: string number_of_outstanding_queued_events: type: integer minimum: 0 maximum: 2147483647 XsltTransformationAliasList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/XsltTransformationAlias' ProjectMetadata: description: Defines a message named Metadata type: object required: - name - version additionalProperties: false properties: description: type: string name: type: string namespace: type: string tags: items: type: string type: array type: enum: - REST - SWAGGER - SOAP - GRAPHQL - ODATA type: string version: type: string domain: enum: - api - ai-platform - mcp type: string labels: type: object additionalProperties: true properties: gatewayTypes: type: array items: type: string JwkSetList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/JwkSet' ProjectAuthorizeUser: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - AuthorizeUser type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: type: boolean users: type: array items: type: string groups: type: array items: type: string teams: type: array items: type: string HttpAuthCredentials: type: object properties: username: type: string password: type: string format: password domain: type: string PolicyList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Policy' AnalyticsServiceList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/AnalyticsService' JwtProviderList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/JwtProvider' ProjectResponseTransformationsSchema: type: object properties: abortAPIExecutionForFailure: type: boolean copyEntireResponse: type: boolean set: type: array items: type: object additionalProperties: false properties: key: type: string value: type: string WebmethodsIsServiceAliasList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/WebmethodsIsServiceAlias' ProjectHTTPEndpoint: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - HTTPEndpoint type: string apiVersion: type: string enum: - api.ibm.com/v1 metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: url: type: string method: type: string connectTimeout: maximum: 4294967295 minimum: 0 type: integer readTimeout: maximum: 4294967295 minimum: 0 type: integer nativeServiceTimeout: maximum: 4294967295 minimum: 0 type: integer serviceRegistryParameters: type: array items: description: The message specified the information related to SSL Configuration type: object additionalProperties: false properties: name: type: string value: type: string sslConfig: type: object additionalProperties: false properties: keyAlias: type: string keyStoreAlias: type: string trustStoreAlias: type: string ProjectXslSchema: type: array items: type: object additionalProperties: false properties: $path: type: string alias: type: string content: type: string feature: type: array items: type: object additionalProperties: false properties: name: type: string value: type: string ProjectErrorProcessingTransformationsSchema: description: Single instance of transformation can be given type: object additionalProperties: false properties: set: type: array items: type: object properties: key: type: string value: type: string remove: type: array items: type: string setPayload: type: object additionalProperties: false properties: content-types: type: array items: type: object additionalProperties: type: string defaultContentType: type: string xsl: $ref: '#/components/schemas/ProjectXslSchema' namespaces: $ref: '#/components/schemas/ProjectNamespaces' sendNativeError: type: boolean ProjectInvoke: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - Invoke type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object required: - endpoint properties: cache: type: object properties: expire: oneOf: - type: object required: - fromMessageHeader properties: fromMessageHeader: type: object required: - headerName - messageName properties: headerName: type: string messageName: type: string additionalProperties: false - type: object required: - fromVariable properties: fromVariable: type: object required: - name properties: name: type: string additionalProperties: false - type: object required: - fromCacheControl properties: fromCacheControl: type: object required: - messageName properties: messageName: type: string additionalProperties: false - type: object required: - static properties: static: type: object required: - seconds properties: seconds: type: integer format: uint64 minimum: 0 additionalProperties: false scope: oneOf: - type: object required: - narrowScope properties: narrowScope: type: object additionalProperties: false - type: object required: - wideScope properties: wideScope: type: object additionalProperties: false additionalProperties: false endpoint: oneOf: - type: object required: - http properties: http: type: object required: - target properties: statusException: type: array items: type: object required: - pattern properties: pattern: type: string pattern: ^[0-9*]{3}$ additionalProperties: false target: type: object required: - url properties: persistentConnections: type: boolean default: true timeout: type: integer format: uint64 minimum: 0 default: 20 tlsClientProfile: type: string url: type: string decompressResponse: type: boolean default: false followRedirects: type: boolean default: false chunkedUpload: type: boolean default: false urlType: type: string enum: - plain - variables - jsonata - distributedVariable compressRequest: type: string enum: - br - gzip - deflate - none version: type: string enum: - HTTP/1.0 - HTTP/1.1 - HTTP/2 additionalProperties: false verb: type: string additionalProperties: false additionalProperties: false input: type: string output: type: string extensions: type: object additionalProperties: false properties: webm-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false properties: endpoint: type: object properties: http: type: object additionalProperties: false properties: target: type: object additionalProperties: false properties: connectionTimeout: type: integer nativeServiceTimeout: type: integer sslConfig: type: object additionalProperties: false properties: keyStoreAlias: type: string keyAlias: type: string trustStoreAlias: type: string serviceRegistryParameters: type: array items: type: object additionalProperties: false properties: name: type: string value: type: string dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' ProjectCORS: description: The CORS related information is captured in the message CORS type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - CORS type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false required: - rules properties: rules: type: array minItems: 1 items: type: object required: - action - originList additionalProperties: false properties: action: type: string enum: - allow - deny originList: description: Multiple instances of allowed origins can be given type: array minItems: 1 items: type: string allowCredentials: description: Credential can be allowed or not allowed type: boolean allowMethods: description: Multiple instances allowed methods can be given type: array minItems: 1 items: type: string uniqueItems: true allowHeaders: description: Multiple instances of allowed headers can be given minItems: 1 items: type: string type: array maxAge: description: Single instance of maximum age can be given maximum: 4294967295 minimum: 0 type: integer exposeHeaders: type: object additionalProperties: false properties: predefined: type: boolean custom: type: string backend: type: boolean ProjectLogInvocationDestinationsList: type: array items: oneOf: - type: string enum: - api_gateway - dev_portals - snmp - jdbc - centraSite - elasticsearch - auditLog - apic - type: object additionalProperties: false properties: email: type: array items: type: string format: email - type: object additionalProperties: false properties: log-file: type: object additionalProperties: false properties: level: type: string enum: - info - debug - warn - error ProjectHTTPInvoke: description: The HTTP Invoke related information is captured in the message HTTPInvoke type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - HTTPInvoke type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: description: Can be enabled or disabled type: boolean condition: type: string endpoint: $ref: '#/components/schemas/ProjectReference' namespaces: $ref: '#/components/schemas/ProjectNamespaces' request_processing: $ref: '#/components/schemas/ProjectInvokeRequestProcessingSchema' response_processing: $ref: '#/components/schemas/ProjectInvokeResponseProcessingSchema' ProjectMockResponse: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - MockResponse type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: code: type: integer data: type: array minItems: 1 items: type: object additionalProperties: false properties: content: type: string contentType: type: string headers: type: array items: type: object additionalProperties: false properties: key: type: string value: type: string PortalService: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - portal_service api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 web_endpoint_base: type: string format: uri runtime_name: type: string maxLength: 50 runtime_id: type: string endpoint: type: string format: uri endpoint_tls_client_profile_url: type: string format: uri state: type: string enum: - pending - ready portal_service_type: type: string enum: - cms - devportal visibility: $ref: '#/components/schemas/ResourceVisibility' owned: type: boolean webhook_url: type: string format: uri webhook_state: type: string catalog_setting_urls: type: array items: type: string format: uri configured_portal_service_urls: type: array items: type: string format: uri org_url: type: string format: uri availability_zone_url: type: string format: uri service_version: type: - string - 'null' communication_kind: type: string enum: - external - internal_svc service_supported_features: type: array items: type: string integration_url: type: string format: uri is_standalone: type: - boolean - 'null' metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectOutboundAnonymous: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - OutboundAnonymous type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: true ProjectIAM: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - IAM type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: accessControl: type: array items: type: array items: oneOf: - type: object additionalProperties: false properties: httpBasic: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate credentialLocation: type: object properties: httpHeader: type: object properties: name: type: string credentialRegistry: type: array items: type: string userGroupAuthorization: type: object additionalProperties: false properties: requiredGroups: type: array items: type: string - type: object additionalProperties: false properties: apiKey: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate credentialLocation: type: object properties: httpHeader: type: object properties: name: type: string - type: object additionalProperties: false properties: oauth: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate credentialLocation: type: object properties: httpHeader: type: object properties: name: type: string providers: type: array items: type: string introspectionCredentials: type: object additionalProperties: false properties: idHeader: type: string secretheader: type: string audClaim: type: array items: type: string requiredScopes: type: array items: type: object additionalProperties: false properties: provider: type: string scopes: type: array items: type: string - type: object additionalProperties: false properties: jwt: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate credentialLocation: type: object properties: httpHeader: type: object properties: name: type: string providers: type: array items: type: string requiredClaims: type: array items: type: object additionalProperties: false properties: provider: type: string claims: type: array items: type: object additionalProperties: false properties: name: type: string value: type: string - type: object additionalProperties: false properties: hostname: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate - type: object additionalProperties: false properties: ipAddress: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate - type: object additionalProperties: false properties: certificate: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate credentialLocation: type: object properties: httpHeader: type: object properties: name: type: string - type: object additionalProperties: false properties: payloadElement: type: object additionalProperties: false properties: name: type: string - type: object additionalProperties: false properties: httpHeaders: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate credentialLocation: type: array items: type: string extensions: type: object properties: dp-nano-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false properties: securityNamespace: type: string accessControl: type: object additionalProperties: false properties: payloadElement: type: array items: type: object additionalProperties: false properties: name: type: string applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate credentialLocation: oneOf: - type: object additionalProperties: false properties: regex: type: string - type: object additionalProperties: false properties: jsonata: type: string webm-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false properties: authenticationMode: type: string enum: - ANY - ALL allowAnonymous: type: object additionalProperties: false properties: {} triggerPolicyViolation: type: boolean accessControl: type: object additionalProperties: false properties: kerberos: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate servicePrincipleName: type: string servicePrinciplePassword: type: string openIdConnect: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate payloadElement: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate payLoadIdentifier: type: array items: oneOf: - type: object required: - jPath additionalProperties: false properties: jPath: type: string - type: object required: - xpath additionalProperties: false properties: xpath: type: string namespaces: type: array items: type: object additionalProperties: false properties: prefix: type: string URI: type: string - type: object required: - regex additionalProperties: false properties: regex: type: string wsSecurityUsernameToken: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate wsSecurityX509Certificate: type: object additionalProperties: false properties: applicationSecurity: type: object additionalProperties: false properties: mode: type: string enum: - authorize - identify - authenticate ProjectResponseProcessingTransformationsSchema: allOf: - $ref: '#/components/schemas/ProjectRequestTransformationsSchema' - type: object properties: namespaces: $ref: '#/components/schemas/ProjectNamespaces' setStatus: type: object additionalProperties: false properties: code: type: string message: type: string webMethodsISService: $ref: '#/components/schemas/ProjectReferenceList' HttpTransportSecurityAliasList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/HttpTransportSecurityAlias' TLSClientProfileList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/TLSClientProfile' AvailabilityZone: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - availability_zone api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 management: type: boolean org_url: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectNanoGwTelemetry: description: Optional telemetry attributes pushed to OpenTelemetry endpoint for nano gateway policies type: object additionalProperties: type: string ProjectSetMediaType: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - SetMediaType type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: defaultAcceptHeader: type: string defaultContentType: type: string ProjectHTTPEndpointV2: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - HTTPEndpoint type: string apiVersion: type: string enum: - api.ibm.com/v2 metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: url: type: string method: type: string connectTimeout: maximum: 4294967295 minimum: 0 type: integer readTimeout: maximum: 4294967295 minimum: 0 type: integer nativeServiceTimeout: maximum: 4294967295 minimum: 0 type: integer serviceRegistryParameters: type: array items: description: A key-value pair specifying an SSL configuration parameter. type: object additionalProperties: false properties: name: type: string value: type: string tlsClientProfile: type: string MailServerProvidedTestConnection: type: object additionalProperties: false properties: mail_server: $ref: '#/components/schemas/MailServer' recipients: type: array items: type: string XsltTransformationAliasMultipart: type: object properties: xsl_file: type: array items: $ref: '#/components/schemas/XsltTransformationAlias' AvailabilityZoneList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/AvailabilityZone' ProjectRequestTransformationsSchema: description: Single instance of transformation can be given type: object properties: set: type: array items: type: object properties: key: type: string value: type: string remove: type: array items: type: string setPayload: type: object additionalProperties: false properties: content-types: type: array items: type: object additionalProperties: type: string defaultContentType: type: string xsl: $ref: '#/components/schemas/ProjectXslSchema' ProjectDataMasking: description: The Data Masking related information is captured in the message Data masking type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - DataMasking type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: applyForPayload: description: Apply for pay load can be enabled or disabled type: boolean applyForTransactionLogging: description: Apply for transaction logging can be enabled or disabled type: boolean enabled: description: Can be enabled or disabled type: boolean matchApplications: description: Multiple instance of match applications can be given type: array items: type: string transformations: description: single instance of transformation can be given type: object additionalProperties: false properties: remove: type: array items: type: object additionalProperties: false properties: jpath: type: string regex: type: string xpath: type: string namespaces: $ref: '#/components/schemas/ProjectNamespaces' set: type: array items: type: object additionalProperties: false properties: jpath: type: string maskValue: type: string namespaces: $ref: '#/components/schemas/ProjectNamespaces' regex: type: string xpath: type: string ProjectUriSchemes: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - URISchemes type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object required: - uriSchemes additionalProperties: false properties: uriSchemes: description: Multiple instance of protocol can be given type: array minItems: 1 items: type: string enum: - http - https extensions: description: Gateway-specific extensions for URI schemes configuration type: object additionalProperties: false properties: webm-gateway: type: object additionalProperties: false properties: apiVersion: type: string description: API version for webm-gateway extension spec: type: object additionalProperties: false properties: soap: type: object description: SOAP-specific configuration for webm-gateway additionalProperties: false properties: version: type: string enum: - '1.1' - '1.2' description: SOAP version (1.1 or 1.2) validateVersion: type: boolean description: Whether to validate SOAP version MailServerList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/MailServer' ProjectWebMethodsISService: description: The Context Variablemrelated information is captured in the message WebMethodsISService. type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - WebMethodsISService type: string apiVersion: enum: - api.ibm.com/v1 type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: type: boolean condition: type: string alias: type: string services: description: Multiple instances of Service can be given type: array items: description: The message specified the information related to Service type: object additionalProperties: false properties: complyToISSpec: type: boolean name: type: string runAs: type: string ProjectRateLimit: description: The Throttling Policy related information is captured in the message ThrottlingPolicy type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - RateLimit type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: target: oneOf: - type: string default: ALL - type: object required: - specified properties: specified: type: array items: type: string limits: type: array minItems: 1 items: type: object additionalProperties: false required: - limitDef properties: limitDef: type: object additionalProperties: false required: - name - definition properties: name: type: string definition: $ref: '#/components/schemas/ProjectReference' operation: type: string enum: - update - consume - replenish - check extensions: type: object properties: webm-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false required: - destination properties: destination: $ref: '#/components/schemas/ProjectDestinationsList' lwgw-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false properties: limits: type: array minItems: 1 items: oneOf: - type: object additionalProperties: false required: - globalLimit properties: globalLimit: type: object additionalProperties: false required: - name - operation properties: name: type: string operation: type: string - type: object additionalProperties: false required: - aliasLimit properties: aliasLimit: type: object additionalProperties: false required: - name - operation properties: name: type: string operation: type: string dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' ProjectInboundBulkHeadV2: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - InboundBulkHead type: string apiVersion: type: string enum: - api.ibm.com/v2 metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false required: - maxConcurrentCalls - retryAfterResponseHeader properties: maxConcurrentCalls: type: integer retryAfterResponseHeader: type: object additionalProperties: false properties: retryAfterValue: type: integer rest: type: object additionalProperties: false properties: enableBulkheadForCallbacks: type: object additionalProperties: false properties: maxConcurrentCallbacks: type: integer ProjectMonitorTraffic: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - MonitorTraffic type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: type: boolean condition: description: Single instance of condition can be given type: string applications: description: Multiple instance of application can be given type: array items: type: string alert-configuration: description: Field 'alert_configuration' with JSON name 'alert-configuration' accepts the value of either 'alert_configuration' or 'alert-configuration' from the YAML file. If both 'alert_configuration' and 'alert-configuration' are specified, the value of 'alert-configuration' takes priority. Multiple instances of alert configuration can be given with JSON name "alert-configuration". type: object additionalProperties: false properties: frequency: type: string enum: - always - once interval: type: string message: type: string notify-on-breach: $ref: '#/components/schemas/ProjectDestinationsList' ProjectInboundMessaging: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - InboundMessaging type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: alias: type: string source: type: array items: type: object additionalProperties: false properties: name: type: string type: type: string enum: - QUEUE - TOPIC selector: type: array items: type: string resource: type: string httpMethod: type: string enum: - GET - POST - PUT - DELETE contentType: type: string OpentelemetryList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Opentelemetry' Truststore: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - truststore api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 truststore: type: string password: type: string format: password entry_urls: type: array items: type: string format: uri tls_server_profile_urls: type: array items: type: string format: uri tls_client_profile_urls: type: array items: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ExtensionDocument: type: object additionalProperties: true required: - extension - info properties: extension: type: string enum: - 1.0.0 info: $ref: '#/components/schemas/InfoSection' properties: type: object additionalProperties: true Implementation: type: object additionalProperties: true Extension: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - extension api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 version: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 scope: type: string state: type: string enum: - public - private extension: $ref: '#/components/schemas/ExtensionDocument' api_urls: type: array items: type: string format: uri org_url: type: string format: uri catalog_url: type: string format: uri space_url: type: string format: uri gateway_service_url: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri UpdateCredentialsResponse: type: object additionalProperties: true ProjectMockEndpoint: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - MockEndpoint type: string apiVersion: type: string enum: - api.ibm.com/v1 metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: paths: type: object additionalProperties: type: object additionalProperties: false properties: get: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' post: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' put: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' patch: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' delete: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' head: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' options: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' trace: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' KerberosCredentials: type: object additionalProperties: false properties: client_password: type: string format: password client_principal: type: string service_principal: type: string service_principal_name_form: type: string enum: - hostbased - username MailServerSavedTestConnection: type: object additionalProperties: false properties: recipients: type: array items: type: string ProjectRateLimitDefinition: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - RateLimitDef type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object properties: consumerSpecific: type: boolean dynamicValue: type: string max: type: integer intervalLen: type: integer intervalUnit: type: string enum: - second - minute - hour - day - week - calendarweek - calendarmonth extensions: type: object properties: dp-nano-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false properties: weightExpr: type: string dynamicValue: type: string exceedAction: type: string intervalOffset: type: number webm-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false properties: alertMessage: type: string alertFrequency: type: string enum: - once - always ProjectNamespaces: type: array minItems: 1 items: $ref: '#/components/schemas/ProjectNamespace' PublicKeyJwk: type: - object - 'null' additionalProperties: false properties: kty: type: string n: type: string e: type: string alg: type: string kid: type: string use: type: string WatsonxSettingsList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/WatsonxSettings' WebmethodsIsServiceAlias: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - webmethods_is_service_alias api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 version: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 service_name: type: string run_as_user: type: string comply_to_integration_server_spec: type: boolean default: true owned: type: boolean visibility: $ref: '#/components/schemas/ResourceVisibility' configured_webmethods_is_service_alias_urls: type: array items: type: string format: uri org_url: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ExtensionList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Extension' SecuredEndpoint: type: - object - 'null' additionalProperties: false required: - endpoint properties: endpoint: type: string format: uri tls_client_profile_url: type: - string - 'null' format: uri SubscriberEventStatus: type: object additionalProperties: false properties: event_id: type: string title: type: string filter: type: string generated_at: type: string processed_at: type: string message: type: string PortalServiceList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/PortalService' ProjectMessageConfig: description: The MessageConfig related information is captured in the message MessageConfig. type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - MessageConfig type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: connectionAlias: type: string destination: type: object additionalProperties: false properties: name: type: string type: type: string enum: - queue - topic replyTo: type: object additionalProperties: false properties: name: type: string type: type: string enum: - queue - topic ttl: type: string timeToWait: type: string deliveryMode: type: string enum: - persistent - non_persistent property: type: array items: description: message properties includes key and value type: object additionalProperties: false properties: key: type: string value: type: string ResourceVisibility: type: object additionalProperties: false properties: type: type: string enum: - public - private - custom group_urls: type: - array - 'null' items: type: string format: uri org_urls: type: - array - 'null' items: type: string format: uri TruststoreList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Truststore' ProjectStagedPolicySequence: description: The policy sequence related information is captured in the message policy sequence type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: apiVersion: type: string kind: enum: - StagedPolicySequence type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object properties: transport: $ref: '#/components/schemas/ProjectReferenceList' security: $ref: '#/components/schemas/ProjectReferenceList' monitoring: $ref: '#/components/schemas/ProjectReferenceList' routing: $ref: '#/components/schemas/ProjectReferenceList' req-processing: $ref: '#/components/schemas/ProjectReferenceList' res-processing: $ref: '#/components/schemas/ProjectReferenceList' error-handling: $ref: '#/components/schemas/ProjectReferenceList' ProjectResponseProcessing: description: The Response Processing related information is captured in the message RequestProcessing type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - TransformResponse type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: description: Can be enabled or disabled type: boolean condition: description: Single instance of condition can be given type: string transformations: $ref: '#/components/schemas/ProjectResponseProcessingTransformationsSchema' ProjectInvokeMessagingExtension: description: The Messaging Extension related information is captured in the message MessagingExtension. type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - InvokeMessagingExtension type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: description: Can be enabled or disabled type: boolean condition: description: Single instance of conidition can be given type: string messageConfig: $ref: '#/components/schemas/ProjectReference' namespaces: $ref: '#/components/schemas/ProjectNamespaces' request_processing: $ref: '#/components/schemas/ProjectInvokeRequestProcessingSchema' response_processing: $ref: '#/components/schemas/ProjectInvokeResponseProcessingSchema' KeystoreList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Keystore' ProjectServiceResultCache: description: The Service Result Cache related information is captured in the message ServiceResultCache type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - CacheServiceResult type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: condition: description: Single instance of condition can be given type: string enabled: description: Can be enabled or disabled type: boolean maxSize: description: single instance pf maximum size can be given type: string ttl: description: Single instance of ttl can be given type: string Entry: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - entry api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 scope: type: string entry_type: type: string enum: - private_key - public_certificate - trusted_certificate pem: type: string certificate_info: type: string cert_name: type: - string - 'null' description: User-friendly name for certificate selection, auto-generated from certificate CN/SAN/O or fingerprint metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectSetContextVariable: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - SetContextVariable type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: description: Can be enabled or disabled type: boolean condition: type: string namespaces: $ref: '#/components/schemas/ProjectNamespaces' variable: description: Multiple instances of variable can be given type: array items: description: The message specified the information related to Variable additionalProperties: false type: object properties: name: type: string value: type: string ProjectMockEndpointMethodResponse: type: object additionalProperties: false properties: defaultResponse: type: object additionalProperties: type: object additionalProperties: false properties: response: $ref: '#/components/schemas/ProjectReference' conditionalResponse: type: array items: $ref: '#/components/schemas/ProjectMockEndpointConditionalResponse' GatewayExtensionMultipart: type: object properties: implementation: type: array items: $ref: '#/components/schemas/Implementation' Error: type: object additionalProperties: false properties: status: type: integer minimum: 400 maximum: 599 message: type: array items: type: string errors: type: array items: type: string WatsonxSettingsTestConnection: type: object additionalProperties: false properties: authType: type: string enum: - iam - bearertoken - cp4d apiKey: type: string bearerToken: type: string username: type: string password: type: string format: password watsonxurl: type: string projectId: type: string spaceId: type: string config_type: type: string enum: - cloud - software instanceId: type: string SubscriberEvent: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - subscriber_event api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 scope: type: string event: type: string filter: type: string event_type: type: string enum: - create - update - delete payload_sent: type: string payload: type: object generated_at: type: string state: type: string enum: - queued - sent - failed retries: type: integer minimum: 0 maximum: 2147483647 request_id: type: string ids_in_payload: type: array readOnly: true items: type: object additionalProperties: false properties: resourceUrl: type: string format: uri-reference resourceType: type: string metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectScopeV2: description: The message identifies the scope type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - Scope type: string apiVersion: type: string enum: - api.ibm.com/v2 metadata: $ref: '#/components/schemas/ProjectMetadata' spec: oneOf: - type: object additionalProperties: false required: - rest - policy-sequence properties: policy-sequence: $ref: '#/components/schemas/ProjectReferenceList' rest: type: object required: - resources additionalProperties: false properties: resources: description: Multiple instances of resources can be given type: array items: description: Multiple instances of methods for each resource can be given type: object required: - methods - path additionalProperties: false properties: methods: type: array minItems: 1 items: type: string enum: - get - post - put - delete - patch - head - keep path: type: string - type: object additionalProperties: false required: - soap - policy-sequence properties: policy-sequence: $ref: '#/components/schemas/ProjectReferenceList' soap: type: object required: - operations additionalProperties: false properties: operations: description: Multiple instances of operations can be given type: array items: type: object required: - name additionalProperties: false properties: name: type: string description: type: string ProjectReqeuestProcessingTransformationsSchema: allOf: - $ref: '#/components/schemas/ProjectRequestTransformationsSchema' - type: object properties: namespaces: $ref: '#/components/schemas/ProjectNamespaces' setMethod: type: string webMethodsISService: $ref: '#/components/schemas/ProjectReferenceList' ProjectReference: type: object required: - $ref additionalProperties: false properties: $ref: description: Field 'ref' with JSON name '$ref' accepts the value of either 'ref' or '$ref' from the YAML file. If both 'ref' and '$ref' are specified, the value of '$ref' takes priority. type: string ProjectValidateAPISpecification: description: The validate API Specification related information is captured in the message validateAPISpecification. type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - ValidateAPISpecification type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object required: - input - validate properties: input: type: string enum: - request - response - message validate: oneOf: - required: - request properties: request: type: object properties: schema: type: object properties: validate: type: boolean query: type: boolean path: type: boolean header: type: boolean cookie: type: boolean contentType: type: boolean - required: - response properties: response: type: object properties: schema: type: object properties: validate: type: boolean header: type: boolean contentType: type: boolean - required: - openApiSchemaRef properties: openApiSchemaRef: type: object required: - schemaReference - failureStatusCode properties: schemaReference: type: string failureStatusCode: type: string enum: - '400' - '500' - required: - file properties: file: type: object required: - $path - failureStatusCode properties: $path: type: string failureStatusCode: type: string enum: - '400' - '500' extensions: type: object properties: webm-gateway: type: object required: - apiVersion - spec properties: apiVersion: type: string spec: type: object properties: validate: type: object properties: custom-headers: type: object properties: condition: type: string schema: type: object properties: feature: type: array items: type: object required: - name - value properties: name: type: string value: type: boolean dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' GatewayServiceList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/GatewayService' XsltTransformationAlias: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - xslt_transformation_alias api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 version: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 file_name: type: string file_content: type: string owned: type: boolean visibility: $ref: '#/components/schemas/ResourceVisibility' configured_xslt_transformation_alias_urls: type: array items: type: string format: uri org_url: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri MailServer: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - mail_server api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 host: type: string port: type: integer minimum: 0 maximum: 65535 credentials: type: object additionalProperties: false properties: username: type: - string - 'null' password: type: - string - 'null' format: password timeout: type: integer minimum: 0 maximum: 2147483647 secure: type: boolean tls_client_profile_url: type: - string - 'null' format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri OAI3: type: - object - 'null' additionalProperties: true PolicyDocument: type: object additionalProperties: true InfoSection: type: object additionalProperties: false required: - title - version properties: name: type: string version: type: string title: type: string description: type: string summary: type: string termsOfService: type: string contact: type: object additionalProperties: false properties: name: type: string url: type: string format: uri email: type: string format: email license: type: object additionalProperties: false required: - name properties: name: type: string url: type: string format: uri x-ibm-languages: type: object additionalProperties: true ProjectSet: description: The Throttling Policy related information is captured in the message ThrottlingPolicy type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - Set type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object oneOf: - required: - messageHeader properties: messageHeader: type: object required: - action - headerName - value - messageName properties: action: type: string enum: - set - add - combine headerName: type: string value: type: string messageName: type: string valueType: type: string enum: - webm-var-expression - plain - variables - jsonata - distributedVariable - required: - messageBody properties: messageBody: type: object required: - messageName - value properties: messageName: type: string value: type: string valueType: type: string enum: - plain - variables - jsonata - distributedVariable - required: - messageMethod properties: messageMethod: type: object required: - messageName - method properties: messageName: type: string method: type: string valueType: type: string enum: - plain - variables - jsonata - distributedVariable - required: - messageUri properties: messageUri: type: object required: - messageName - nameType - path - queryParams properties: messageName: type: string nameType: type: string enum: - plain - variables - jsonata - distributedVariable path: type: string queryParams: type: array items: type: object required: - name - value properties: name: type: string value: type: string valueType: type: string enum: - plain - variables - jsonata - distributedVariable - required: - variable properties: variable: type: object required: - name - value properties: name: type: string value: type: string valueType: type: string enum: - plain - variables - jsonata - distributedVariable - required: - distributedVariable properties: distributedVariable: type: object required: - expire - name - setExclusive - value properties: expire: type: integer name: type: string setExclusive: type: boolean value: type: string valueType: type: string enum: - plain - variables - jsonata - distributedVariable - required: - telemetry - valueType additionalProperties: false properties: telemetry: type: object required: - key - span - value additionalProperties: false properties: key: type: string span: oneOf: - type: string - type: object oneOf: - required: - policySpan properties: policySpan: type: string - required: - httpSpan properties: httpSpan: type: string value: type: string valueType: type: string enum: - plain - variables - jsonata - distributedVariable OauthProviderList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/OauthProvider' JwkSet: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - jwk_set api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 keys: type: array items: $ref: '#/components/schemas/JWKDefinition' user_registry_urls: type: array items: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectLogInvocation: description: The Log Invocation related information is captured in the message LogInvocation type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - Log type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: type: boolean logRequestHeaders: type: boolean default: false logResponseHeaders: type: boolean default: false logRequestPayload: type: boolean default: false logResponsePayload: type: boolean default: false compressPayloads: type: boolean default: false logGenerationFrequency: type: string enum: - always - onfailure - onsuccess destination: $ref: '#/components/schemas/ProjectLogInvocationDestinationsList' WatsonxSettingsTestConnectionResponse: type: object additionalProperties: false properties: available_models: type: array items: type: object additionalProperties: false properties: model_type: type: string model_id: type: string is_latest: type: boolean ProjectRoute: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - Route type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: oneOf: - type: object description: Default routing - Applicable only for SOAP additionalProperties: false required: - default-endpoint properties: default-endpoint: $ref: '#/components/schemas/ProjectReference' - type: object description: Load balancer routing with multiple endpoints required: - load-balancer-endpoints additionalProperties: false properties: load-balancer-endpoints: type: array minItems: 1 items: type: object required: - $ref additionalProperties: false properties: $ref: type: string description: Reference to SOAP Endpoint suspendDuration: type: integer description: Suspend duration in seconds minimum: 0 - type: object description: Routing info for conditional routing additionalProperties: false required: - default-endpoint - conditional-endpoints properties: default-endpoint: $ref: '#/components/schemas/ProjectReference' conditional-endpoints: type: array items: type: object additionalProperties: false properties: condition: type: string endpoint: $ref: '#/components/schemas/ProjectReference' - type: object description: Routing info for content based routing additionalProperties: false required: - default-endpoint - content-based-endpoints properties: default-endpoint: $ref: '#/components/schemas/ProjectReference' content-based-endpoints: type: array items: type: object additionalProperties: false properties: payloadIdentifier: oneOf: - type: object additionalProperties: false properties: jPath: type: string - type: object additionalProperties: false properties: xpath: type: string namespaces: type: array items: type: object additionalProperties: false properties: prefix: type: string URI: type: string - type: object additionalProperties: false properties: regex: type: string endpoint: $ref: '#/components/schemas/ProjectReference' - type: object description: Routing info for dynamic routing additionalProperties: false required: - default-endpoint - dynamic-endpoints properties: default-endpoint: $ref: '#/components/schemas/ProjectReference' dynamic-endpoints: type: object additionalProperties: false properties: useHeader: type: object additionalProperties: false properties: name: type: string $ref: type: string useContext: $ref: '#/components/schemas/ProjectReference' - type: object description: Routing info for mock routing additionalProperties: false properties: mock-endpoint: type: object additionalProperties: false properties: enabled: type: boolean $ref: type: string - type: object description: Routing info for message config routing additionalProperties: false properties: messageConfig: $ref: '#/components/schemas/ProjectReference' ProjectWebMethodsISServiceV2: description: The Context Variablemrelated information is captured in the message WebMethodsISService. type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - WebMethodsISService type: string apiVersion: enum: - api.ibm.com/v2 type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: type: boolean condition: type: string alias: type: array items: type: string services: description: Multiple instances of Service can be given type: array items: description: The message specified the information related to Service type: object additionalProperties: false properties: complyToISSpec: type: boolean name: type: string runAs: type: string JWKDefinition: type: object additionalProperties: false properties: kid: type: string x5c: type: array items: type: string kty: type: string use: type: string alg: type: string iss: type: string purpose: type: string e: type: string n: type: string d: type: string p: type: string q: type: string dp: type: string dq: type: string qi: type: string GatewayService: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - gateway_service api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 integration_url: type: string format: uri gateway_service_type: type: string runtime_name: type: string maxLength: 50 runtime_id: type: string endpoint: type: string format: uri api_endpoint_base: type: string tls_client_profile_url: type: string format: uri sni: type: array items: type: object additionalProperties: false properties: host: type: string tls_server_profile_url: type: string format: uri state: type: string enum: - pending - ready oauth_shared_secret: type: string format: password visibility: $ref: '#/components/schemas/ResourceVisibility' owned: type: boolean configuration: type: object analytics_service_url: type: - string - 'null' format: uri opentelemetry_url: type: - string - 'null' format: uri webhook_url: type: string format: uri webhook_state: type: string cloud_setting_urls: type: array items: type: string format: uri configured_gateway_service_urls: type: array items: type: string format: uri gateway_extension_urls: type: array items: type: string format: uri org_url: type: string format: uri availability_zone_url: type: string format: uri service_version: type: - string - 'null' ldap_cxn_pool: type: object additionalProperties: false properties: enabled: type: boolean idle_timeout: type: integer minimum: 1 maximum: 86400 max_pool_size: type: integer minimum: 1 maximum: 2000 document_cache_size: type: integer minimum: 0 maximum: 2147483647 communication_kind: type: string enum: - external - internal_svc communication_to_analytics_kind: type: string enum: - external - internal_svc communication_to_analytics_with_jwt: type: - boolean - 'null' gateway_processing_status: $ref: '#/components/schemas/SubscriberProcessingStatus' events: type: object properties: sent_events: type: array items: $ref: '#/components/schemas/SubscriberEvent' queued_events: type: array items: $ref: '#/components/schemas/SubscriberEvent' service_supported_features: type: array items: type: string ai_gateway_enabled: type: boolean cipher_suites: type: array items: type: string disabled_protocols: type: array items: type: string dp_nano_gw_limits: type: object additionalProperties: false properties: cpu: type: string memory: type: string replicas: type: integer minimum: 0 maximum: 128 allow_overrides: type: boolean hpa: type: object additionalProperties: false properties: min_replicas: type: integer minimum: 1 max_replicas: type: integer minimum: 2 dp_nano_gw_configuration: type: object additionalProperties: false properties: hpa: type: object additionalProperties: false properties: enabled: type: boolean min_replicas: type: integer minimum: 1 max_replicas: type: integer minimum: 2 target_cpu: type: integer minimum: 1 target_memory: type: integer minimum: 1 to_zero_time: type: integer minimum: 0 from_zero_replicas: type: integer minimum: 1 maximum: 100 metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectReferenceList: type: array items: $ref: '#/components/schemas/ProjectReference' CertEntry: type: object additionalProperties: false properties: pem: type: string certificate_info: type: string AliasList: type: object properties: http_transport_security_aliases: type: array items: $ref: '#/components/schemas/HttpTransportSecurityAlias' webmethods_is_service_aliases: type: array items: $ref: '#/components/schemas/WebmethodsIsServiceAlias' xslt_transformation_aliases: type: array items: $ref: '#/components/schemas/XsltTransformationAlias' ProjectLoadBalancer: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - LoadBalancer type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: input: type: string output: type: string weightedRandomHttp: type: object additionalProperties: false properties: verb: type: string statusException: type: array items: type: object properties: pattern: type: string endpoints: type: array minItems: 1 items: type: object required: - endpoint properties: endpoint: type: object properties: name: type: string tlsClientProfile: type: string url: type: string urlType: type: string enum: - plain - variables - jsonata - distributedVariable version: type: string enum: - HTTP/1.0 - HTTP/1.1 - HTTP/2 timeout: type: integer compressRequest: type: string enum: - gzip - br - deflate - none decompressResponse: type: boolean followRedirects: type: boolean chunkedUpload: type: boolean persistentConnections: type: boolean suspendTimeout: type: integer weight: type: integer roundRobinHttp: type: object additionalProperties: false properties: verb: type: string statusException: type: array items: type: object required: - pattern properties: pattern: type: string pattern: ^[0-9*]{3}$ additionalProperties: false endpoints: type: array minItems: 1 items: type: object required: - endpoint additionalProperties: false properties: suspendTimeout: type: integer endpoint: type: object additionalProperties: false properties: name: type: string tlsClientProfile: type: string url: type: string urlType: type: string enum: - plain - variables - jsonata - distributedVariable compressRequest: type: string enum: - br - gzip - deflate - none version: type: string enum: - HTTP/1.0 - HTTP/1.1 - HTTP/2 timeout: type: integer decompressResponse: type: boolean default: false followRedirects: type: boolean default: false chunkedUpload: type: boolean persistentConnections: type: boolean extensions: type: object properties: webm-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false properties: endpoints: type: array items: type: object additionalProperties: false properties: name: type: string connectionTimeout: type: integer nativeServiceTimeout: type: integer sslConfig: type: object additionalProperties: false properties: keyStoreAlias: type: string keyAlias: type: string trustStoreAlias: type: string serviceRegistryParameters: type: array items: type: object additionalProperties: false properties: name: type: string value: type: string dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' PolicyInstance: oneOf: - $ref: '#/components/schemas/ProjectAWSLambda' - $ref: '#/components/schemas/ProjectValidateAPISpecification' - $ref: '#/components/schemas/ProjectUriSchemes' - $ref: '#/components/schemas/ProjectInvoke' - $ref: '#/components/schemas/ProjectLoadBalancer' - $ref: '#/components/schemas/ProjectSetAuthorization' - $ref: '#/components/schemas/ProjectStagedPolicySequence' - $ref: '#/components/schemas/ProjectInboundBulkHead' - $ref: '#/components/schemas/ProjectInboundBulkHeadV2' - $ref: '#/components/schemas/ProjectSetMediaType' - $ref: '#/components/schemas/ProjectInboundMessaging' - $ref: '#/components/schemas/ProjectIAM' - $ref: '#/components/schemas/ProjectAuthorizeUser' - $ref: '#/components/schemas/ProjectSetContextVariable' - $ref: '#/components/schemas/ProjectWebMethodsISService' - $ref: '#/components/schemas/ProjectWebMethodsISServiceV2' - $ref: '#/components/schemas/ProjectLogInvocation' - $ref: '#/components/schemas/ProjectMonitorTraffic' - $ref: '#/components/schemas/ProjectServiceResultCache' - $ref: '#/components/schemas/ProjectOutboundAlias' - $ref: '#/components/schemas/ProjectOutboundAnonymous' - $ref: '#/components/schemas/ProjectHTTPInvoke' - $ref: '#/components/schemas/ProjectInvokeMessagingExtension' - $ref: '#/components/schemas/ProjectDataMasking' - $ref: '#/components/schemas/ProjectRequestProcessing' - $ref: '#/components/schemas/ProjectResponseProcessing' - $ref: '#/components/schemas/ProjectRoute' - $ref: '#/components/schemas/ProjectMessageConfig' - $ref: '#/components/schemas/ProjectHTTPEndpoint' - $ref: '#/components/schemas/ProjectHTTPEndpointV2' - $ref: '#/components/schemas/ProjectMockEndpoint' - $ref: '#/components/schemas/ProjectMockEndpointV2' - $ref: '#/components/schemas/ProjectMockResponse' - $ref: '#/components/schemas/ProjectErrorProcessing' - $ref: '#/components/schemas/ProjectSet' - $ref: '#/components/schemas/ProjectRateLimit' - $ref: '#/components/schemas/ProjectRateLimitDefinition' - $ref: '#/components/schemas/ProjectScope' - $ref: '#/components/schemas/ProjectScopeV2' - $ref: '#/components/schemas/ProjectCORS' GatewayExtension: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - gateway_extension api_version: type: string readOnly: true enum: - 2.0.0 name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 scope: type: string implementation: type: object additionalProperties: false required: - content_type - content properties: content_type: type: string enum: - application/zip content: type: string format: binary org_url: type: string format: uri gateway_service_url: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectDestinationsList: type: array items: oneOf: - type: string enum: - api_gateway - dev_portals - snmp - jdbc - centraSite - elasticsearch - auditLog - apic - type: object additionalProperties: false properties: email: type: array items: type: string format: email - type: object additionalProperties: false properties: log-file: type: object additionalProperties: false properties: level: type: string enum: - info - debug - warn - error ProjectScope: description: The message identifies the scope type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - Scope type: string apiVersion: type: string enum: - api.ibm.com/v1 metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object required: - policy-sequence - resources additionalProperties: false properties: policy-sequence: $ref: '#/components/schemas/ProjectReferenceList' resources: description: Multiple instances of resources can be given type: array items: description: Multiple instances of methods for each resource can be given type: object required: - methods - path additionalProperties: false properties: methods: type: array minItems: 1 items: type: string enum: - get - post - put - delete - patch - head - keep path: type: string JwtProvider: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - jwt_provider api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 debug: type: boolean owned: type: boolean gateway_version: type: string enum: - '12000' native_jwt_provider: type: object additionalProperties: false properties: jwks_config: type: string enum: - signing - encryption - nested jws_jwk_source: type: - string - 'null' enum: - kube_secret - endpoint jwe_jwk_source: type: - string - 'null' enum: - kube_secret - endpoint signing_key: type: - string - 'null' encryption_key: type: - string - 'null' signing_key_endpoint: type: - object - 'null' additionalProperties: false required: - endpoint properties: endpoint: type: string security: type: array items: type: string enum: - basic-auth - none basic_auth: type: object additionalProperties: false properties: username: type: string password: type: - string - 'null' tls_client_profile_url: type: - string - 'null' format: uri version: type: - string - 'null' enum: - HTTP/1.0 - HTTP/1.1 - HTTP/2 url_type: type: - string - 'null' enum: - plain - variables - jsonata timeout: type: - integer - 'null' persistent_connections: type: boolean compress_request: type: - string - 'null' enum: - br - gzip - deflate - none decompress_response: type: boolean chunked_upload: type: boolean follow_redirects: type: boolean encryption_key_endpoint: type: - object - 'null' additionalProperties: false required: - endpoint properties: endpoint: type: string security: type: array items: type: string enum: - basic-auth - none basic_auth: type: object additionalProperties: false properties: username: type: string password: type: - string - 'null' tls_client_profile_url: type: - string - 'null' format: uri version: type: - string - 'null' enum: - HTTP/1.0 - HTTP/1.1 - HTTP/2 url_type: type: - string - 'null' enum: - plain - variables - jsonata timeout: type: - integer - 'null' persistent_connections: type: boolean compress_request: type: - string - 'null' enum: - br - gzip - deflate - none decompress_response: type: boolean chunked_upload: type: boolean follow_redirects: type: boolean clock_skew: type: - integer - 'null' aud_claim: type: - array - 'null' items: type: string iss_claim: type: - string - 'null' visibility: $ref: '#/components/schemas/ResourceVisibility' tls_client_profile_urls: type: array items: type: string format: uri org_url: type: string format: uri configured_jwt_provider_urls: type: array items: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectRequestProcessing: description: The Request Processing related information is captured in the message RequestProcessing type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - TransformRequest type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: enabled: description: Can be enabled or disabled type: boolean condition: description: Single instance of condition can be given type: string transformations: $ref: '#/components/schemas/ProjectReqeuestProcessingTransformationsSchema' ProjectAWSLambda: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - InvokeAWSLambda type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: functionName: description: Name of the AWS Lambda function type: string qualifier: description: Version of the AWS Lambda function type: string invocationType: type: string enum: - requestResponse - event region: type: string awsAuthType: type: object properties: accessSecret: type: string tlsClientProfile: type: string input: type: string output: type: string clientConfig: type: object additionalProperties: false properties: socketTimeout: type: integer connectionTimeout: type: integer requestTimeout: type: integer clientExecutionTimeout: type: integer clientRetryCount: type: integer connectionExpirationTimeout: type: integer enableExpectContinue: type: boolean enableGzip: type: boolean enableHostPrefixInjection: type: boolean maxConnectionIdleTime: type: integer responseMetadataCacheSize: type: integer enableThrottledRetries: type: boolean enableKeepAlive: type: boolean enableResponseMetadataCache: type: boolean signatureAlgorithm: type: string tcpSendBufferSizeHint: type: integer tcpReceiveBufferSizeHint: type: integer extensions: type: object properties: dp-nano-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false properties: clientConfig: type: object additionalProperties: false properties: serverRetryCount: type: integer telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' webm-gateway: type: object additionalProperties: false properties: apiVersion: type: string spec: type: object additionalProperties: false properties: condition: type: string lambdaConfig: type: object additionalProperties: false properties: alias: type: string clientConfig: type: object additionalProperties: false properties: retryOnErrorCount: type: integer request_processing: $ref: '#/components/schemas/ProjectInvokeRequestProcessingSchema' response_processing: $ref: '#/components/schemas/ProjectInvokeResponseProcessingSchema' namespaces: $ref: '#/components/schemas/ProjectNamespaces' Policy: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - policy api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 version: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 scope: type: string state: type: string enum: - public - private custom: type: boolean instance: type: boolean policy: $ref: '#/components/schemas/PolicyDocument' implementation: type: object additionalProperties: false required: - content_type - content properties: content_type: type: string enum: - application/zip content: type: string format: binary attachments: type: array items: type: object additionalProperties: false required: - content_type - content properties: content_type: type: string description: MIME type of the attached file content: type: string format: binary description: Binary content of the attached file filename: type: string description: Original filename of the attachment policy_kind: $ref: '#/components/schemas/PolicyInstance' api_urls: type: array items: type: string format: uri global_policy_urls: type: array items: type: string format: uri org_url: type: string format: uri catalog_url: type: string format: uri space_url: type: string format: uri gateway_service_url: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectInvokeRequestProcessingSchema: description: Field 'request_processing' with JSON name 'request-processing' accepts the value of either 'request_processing' or 'request-processing' from the YAML file. If both 'request_processing' and 'request-processing' are specified, the value of 'request-processing' takes priority. Single instances of request processing can be given with JSON name "request-processing". type: object additionalProperties: false required: - transformations properties: transformations: $ref: '#/components/schemas/ProjectRequestTransformationsSchema' useIncomingHeaders: type: boolean HttpTransportSecurityAlias: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - http_transport_security_alias api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 version: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 auth_scheme: type: string enum: - http_basic - kerberos - ntlm - oauth2 - jwt auth_mode: type: string enum: - new - incoming_http_basic_auth - delegate_incoming - incoming_oauth_token - incoming_jwt - transparent - incoming_kerberos http_auth_credentials: $ref: '#/components/schemas/HttpAuthCredentials' kerberos_credentials: $ref: '#/components/schemas/KerberosCredentials' oauth2_token: type: string owned: type: boolean visibility: $ref: '#/components/schemas/ResourceVisibility' configured_http_transport_security_alias_urls: type: array items: type: string format: uri org_url: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectMockEndpointConditionalResponse: type: object additionalProperties: false properties: condition: type: string statusCode: type: integer response: $ref: '#/components/schemas/ProjectReference' TLSServerProfile: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - tls_server_profile api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 version: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 protocols: type: array items: type: string enum: - tls_v1.0 - tls_v1.1 - tls_v1.2 - tls_v1.3 ciphers: type: - array - 'null' items: type: string enum: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - TLS_AES_128_CCM_SHA256 - TLS_AES_128_CCM_8_SHA256 - ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - ECDHE_RSA_WITH_AES_256_GCM_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_256_CBC_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA - ECDHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 - DHE_DSS_WITH_AES_256_CBC_SHA256 - DHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_CBC_SHA - RSA_WITH_AES_256_GCM_SHA384 - RSA_WITH_AES_256_CBC_SHA256 - RSA_WITH_AES_256_CBC_SHA - ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - ECDHE_RSA_WITH_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - ECDHE_RSA_WITH_AES_128_CBC_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA256 - DHE_DSS_WITH_AES_128_CBC_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_CBC_SHA - RSA_WITH_AES_128_GCM_SHA256 - RSA_WITH_AES_128_CBC_SHA256 - RSA_WITH_AES_128_CBC_SHA - ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_DSS_WITH_3DES_EDE_CBC_SHA - RSA_WITH_3DES_EDE_CBC_SHA key_exchange_mechanisms: type: array items: type: string enum: - MLKEM512 - MLKEM768 - X25519MLKEM768 - SecP256r1MLKEM768 - MLKEM1024 - SecP384r1MLKEM1024 - p256 - p384 - p521 - x25519 - x448 - ffdhe2048 - ffdhe3072 - ffdhe4096 - ffdhe6144 - ffdhe8192 - brainpoolP256 - brainpoolP384 - brainpoolP512 elliptic_curve: type: - array - 'null' items: type: string enum: - sect163k1 - sect163r1 - sect163r2 - sect193r1 - sect193r2 - sect233k1 - sect233r1 - sect239k1 - sect283k1 - sect283r1 - sect409k1 - sect409r1 - sect571k1 - sect571r1 - secp160k1 - secp160r1 - secp160r2 - secp192k1 - secp192r1 - secp224k1 - secp224r1 - secp256k1 - secp256r1 - secp384r1 - secp521r1 - brainpoolP256r1 - brainpoolP384r1 - brainpoolP512r1 mutual_authentication: type: string enum: - require - request - none limit_renegotiation: type: boolean default: true keystore_url: type: string format: uri key_name: type: - string - 'null' description: Selects a specific key+certificate pair from the keystore by name (for multi-key keystores). If not specified, uses the first/default key. truststore_url: type: - string - 'null' format: uri cert_name: type: - string - 'null' description: Selects a specific certificate from the truststore by name. If not specified, all certificates in the truststore are used. gateway_service_urls: type: array items: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectInboundBulkHead: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - InboundBulkHead type: string apiVersion: type: string enum: - api.ibm.com/v1 metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object additionalProperties: false properties: maxConcurrentCalls: type: integer enableBulkheadForCallbacks: type: object additionalProperties: false properties: maxConcurrentCallbacks: type: integer retryAfterResponseHeader: type: object additionalProperties: false properties: retryAfterValue: type: integer ProjectSetAuthorization: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - SetAuthorization type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object oneOf: - required: - basic properties: basic: oneOf: - type: object required: - static properties: static: type: object required: - username - password properties: username: type: string password: type: string valueType: type: string enum: - plain - jsonata - type: object required: - useIncoming properties: useIncoming: type: object - type: object required: - secret properties: secret: type: string additionalProperties: false message: type: string extensions: type: object properties: dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' - required: - oAuth2 properties: oAuth2: oneOf: - type: object required: - token properties: token: type: string - type: object required: - useIncoming properties: useIncoming: type: object - type: object required: - secret properties: secret: type: string message: type: string extensions: type: object properties: dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' - required: - ntlm properties: ntlm: oneOf: - type: object required: - static properties: static: type: object required: - username - password properties: username: type: string password: type: string - type: object required: - useIncoming properties: useIncoming: type: object - type: object required: - transparent properties: transparent: type: object additionalProperties: false message: type: string extensions: type: object properties: dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' - required: - jwt properties: jwt: oneOf: - type: object required: - useIncoming properties: useIncoming: type: object - type: object required: - secret properties: secret: type: string additionalProperties: false message: type: string extensions: type: object properties: dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' - required: - kerberos properties: kerberos: oneOf: - type: object required: - useIncoming properties: useIncoming: type: object - type: object required: - delegateIncomingCredentials properties: delegateIncomingCredentials: type: object required: - clientPassword - clientPrincipal - servicePrincipal - servicePrincipalNameform properties: clientPassword: type: string clientPrincipal: type: string servicePrincipal: type: string servicePrincipalNameform: type: string enum: - Username - Hostbased - type: object required: - incomingHTTPBasicAuthCred properties: incomingHTTPBasicAuthCred: type: object required: - servicePrincipal - servicePrincipalNameform properties: servicePrincipal: type: string servicePrincipalNameform: type: string enum: - Username - Hostbased - type: object required: - useCustomCredentials properties: useCustomCredentials: type: object required: - clientPassword - clientPrincipal - servicePrincipal - servicePrincipalNameform properties: clientPassword: type: string clientPrincipal: type: string servicePrincipal: type: string servicePrincipalNameform: type: string enum: - Username - Hostbased message: type: string extensions: type: object properties: dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' - required: - anonymous properties: anonymous: type: object message: type: string extensions: type: object properties: dp-nano-gateway: type: object properties: apiVersion: type: string spec: type: object properties: telemetry: $ref: '#/components/schemas/ProjectNanoGwTelemetry' ProjectInvokeResponseProcessingSchema: description: Field 'response_processing' with JSON name 'response-processing' accepts the value of either 'response_processing' or 'response-processing' from the YAML file. If both 'response_processing' and 'response-processing' are specified, the value of 'response-processing' takes priority. Single instances of response processing can be given with JSON name "response-processing". type: object additionalProperties: false required: - transformations properties: transformations: $ref: '#/components/schemas/ProjectResponseTransformationsSchema' TLSClientProfile: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - tls_client_profile api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 version: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 protocols: type: array items: type: string enum: - tls_v1.0 - tls_v1.1 - tls_v1.2 - tls_v1.3 ciphers: type: - array - 'null' items: type: string enum: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - TLS_AES_128_CCM_SHA256 - TLS_AES_128_CCM_8_SHA256 - ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - ECDHE_RSA_WITH_AES_256_GCM_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - ECDHE_RSA_WITH_AES_256_CBC_SHA384 - ECDHE_ECDSA_WITH_AES_256_CBC_SHA - ECDHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_GCM_SHA384 - DHE_RSA_WITH_AES_256_CBC_SHA256 - DHE_DSS_WITH_AES_256_CBC_SHA256 - DHE_RSA_WITH_AES_256_CBC_SHA - DHE_DSS_WITH_AES_256_CBC_SHA - RSA_WITH_AES_256_GCM_SHA384 - RSA_WITH_AES_256_CBC_SHA256 - RSA_WITH_AES_256_CBC_SHA - ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - ECDHE_RSA_WITH_AES_128_GCM_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - ECDHE_RSA_WITH_AES_128_CBC_SHA256 - ECDHE_ECDSA_WITH_AES_128_CBC_SHA - ECDHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_GCM_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA256 - DHE_DSS_WITH_AES_128_CBC_SHA256 - DHE_RSA_WITH_AES_128_CBC_SHA - DHE_DSS_WITH_AES_128_CBC_SHA - RSA_WITH_AES_128_GCM_SHA256 - RSA_WITH_AES_128_CBC_SHA256 - RSA_WITH_AES_128_CBC_SHA - ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_RSA_WITH_3DES_EDE_CBC_SHA - DHE_DSS_WITH_3DES_EDE_CBC_SHA - RSA_WITH_3DES_EDE_CBC_SHA key_exchange_mechanisms: type: array items: type: string enum: - MLKEM512 - MLKEM768 - X25519MLKEM768 - SecP256r1MLKEM768 - MLKEM1024 - SecP384r1MLKEM1024 - p256 - p384 - p521 - x25519 - x448 - ffdhe2048 - ffdhe3072 - ffdhe4096 - ffdhe6144 - ffdhe8192 - brainpoolP256 - brainpoolP384 - brainpoolP512 elliptic_curve_auto_negotiation: type: boolean default: true elliptic_curve: type: - array - 'null' items: type: string enum: - sect163k1 - sect163r1 - sect163r2 - sect193r1 - sect193r2 - sect233k1 - sect233r1 - sect239k1 - sect283k1 - sect283r1 - sect409k1 - sect409r1 - sect571k1 - sect571r1 - secp160k1 - secp160r1 - secp160r2 - secp192k1 - secp192r1 - prime192v1 - secp224k1 - secp224r1 - secp256k1 - secp256r1 - prime256v1 - secp384r1 - secp521r1 - brainpoolP256r1 - brainpoolP384r1 - brainpoolP512r1 insecure_server_connections: type: boolean server_name_indication: type: boolean default: true owned: type: boolean keystore_url: type: - string - 'null' format: uri truststore_url: type: - string - 'null' format: uri key_name: type: - string - 'null' description: Selects a specific key+certificate pair from the keystore by name (for multi-key keystores). If not specified, uses the first/default key. cert_name: type: - string - 'null' description: Selects a specific certificate from the truststore by name. If not specified, all certificates in the truststore are used. webhook_urls: type: array items: type: string format: uri visibility: $ref: '#/components/schemas/ResourceVisibility' configured_tls_client_profile_urls: type: array items: type: string format: uri oauth_provider_urls: type: array items: type: string format: uri jwt_provider_urls: type: array items: type: string format: uri configured_oauth_provider_urls: type: array items: type: string format: uri configured_jwt_provider_urls: type: array items: type: string format: uri mail_server_urls: type: array items: type: string format: uri gateway_service_urls: type: array items: type: string format: uri portal_service_urls: type: array items: type: string format: uri analytics_service_urls: type: array items: type: string format: uri org_url: type: string format: uri cloud_setting_urls: type: array items: type: string format: uri integration_urls: type: array items: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectOutboundAlias: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - OutboundAlias type: string apiVersion: type: string metadata: $ref: '#/components/schemas/ProjectMetadata' spec: type: object required: - alias additionalProperties: false properties: alias: type: string AnalyticsService: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - analytics_service api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 endpoint: type: string format: uri ingestion_endpoint: type: string format: uri ingestion_endpoint_tls_client_profile_url: type: string format: uri client_endpoint: type: string format: uri client_endpoint_tls_client_profile_url: type: string format: uri internal_svc_endpoint: type: string format: uri internal_svc_endpoint_tls_client_profile_url: type: string format: uri gateway_service_urls: type: array items: type: string format: uri org_url: type: string format: uri catalog_url: type: string format: uri availability_zone_url: type: string format: uri service_version: type: - string - 'null' webhook_url: type: string format: uri catalog_webhook_url: type: string format: uri communication_from_apim_kind: type: string enum: - external - internal_svc cloud_setting_urls: type: array items: type: string format: uri scope: type: string metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri TLSServerProfileList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/TLSServerProfile' ProjectNamespace: type: object additionalProperties: false properties: URI: type: string prefix: type: string EntryList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Entry' OauthProvider: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - oauth_provider api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 debug: type: boolean owned: type: boolean provider_type: type: string enum: - native - third_party scopes: type: - object - 'null' additionalProperties: type: string grants: type: array items: type: string enum: - access_code - application - password - implicit - jwt gateway_version: type: string enum: - '5000' - '6000' - '12000' - '13000' advanced_scope: type: object additionalProperties: false properties: enabled: type: boolean override_endpoint_from_api: type: boolean default_validator_endpoint: type: - object - 'null' additionalProperties: false required: - endpoint properties: endpoint: type: string tls_client_profile_url: type: - string - 'null' format: uri request_query: type: string request_headers_regex: type: string response_headers_regex: type: string advanced_scope_12000: type: object additionalProperties: false properties: default_validator_endpoint: type: - object - 'null' additionalProperties: false required: - endpoint properties: endpoint: type: string tls_client_profile_url: type: - string - 'null' format: uri version: type: - string - 'null' enum: - HTTP/1.0 - HTTP/1.1 - HTTP/2 timeout: type: - integer - 'null' persistent_connections: type: boolean compress_request: type: - string - 'null' enum: - br - gzip - deflate - none decompress_response: type: boolean chunked_upload: type: boolean follow_redirects: type: boolean native_provider: type: object additionalProperties: false properties: api: $ref: '#/components/schemas/OAI3' default_scopes: type: - string - 'null' authorize_path: type: string token_path: type: string token_secret: type: - object - 'null' additionalProperties: false properties: name: type: string key: type: string clients: type: array items: type: string enum: - confidential - public access_code_ttl: type: integer minimum: 1 maximum: 600 access_token_ttl: type: integer minimum: 0 maximum: 2147483647 access_token_one_time_use: type: boolean maximum_consent_ttl: type: integer minimum: 0 maximum: 2147483647 refresh_token: type: object additionalProperties: false properties: enabled: type: boolean count: type: integer minimum: 0 maximum: 2147483647 ttl: type: integer minimum: 0 maximum: 2147483647 one_time_use: type: boolean revocation: type: object additionalProperties: false properties: enabled: type: boolean type: type: string enum: - native - third_party resource_owner_revocation_path: type: string client_revocation_path: type: string third_party_endpoint: type: - object - 'null' additionalProperties: false required: - endpoint properties: endpoint: type: string tls_client_profile_url: type: - string - 'null' format: uri application_revocation: type: object additionalProperties: false properties: enabled: type: boolean apprevoke_path: type: string third_party_security: type: array items: type: string enum: - basic-auth basic_auth: type: object additionalProperties: false properties: username: type: string password: type: - string - 'null' request_headername: type: string custom_headername_format: type: string third_party_cache_type: type: array items: type: string enum: - no-cache - protocol - time-to-live third_party_revocation_protocol: type: string items: type: string enum: - XML - JSON time_to_live: type: object additionalProperties: false properties: cache_ttl: type: integer third_party_fail_on_error: type: boolean default: true owner_revocation: type: object additionalProperties: false properties: enabled: type: boolean owner_revoke_path: type: string token_introspection: type: object additionalProperties: false properties: enabled: type: boolean introspection_path: type: string token_metadata: type: object additionalProperties: false properties: enabled: type: boolean source: type: array items: type: string enum: - external_url - authentication_url external_endpoint: type: - object - 'null' additionalProperties: false required: - endpoint properties: endpoint: type: string tls_client_profile_url: type: - string - 'null' format: uri header_name_token: type: string header_name_payload: type: string openid_connect: type: object additionalProperties: false properties: enabled: type: boolean discovery_path: type: - string - 'null' supported_response_types: type: array items: type: string enum: - code_id_token - code_access_token - code_id_token_access_token pkce: type: object additionalProperties: false properties: enabled: type: boolean required: type: boolean allow_plain: type: boolean advanced_scope_security: type: object additionalProperties: false properties: enabled: type: boolean mode: type: array items: type: string enum: - basic-auth basic_auth: type: object additionalProperties: false properties: request_headername: type: string username: type: string password: type: - string - 'null' native_provider_5000: type: object additionalProperties: false properties: identity_extraction: type: object additionalProperties: false properties: type: type: string enum: - basic - default_form - custom_form - redirect redirect_endpoint: type: - string - 'null' custom_form_endpoint: $ref: '#/components/schemas/SecuredEndpoint' authentication: type: object additionalProperties: false properties: user_registry_url: type: string format: uri authorization: type: object additionalProperties: false properties: type: type: string enum: - default_form - custom_form - authenticated custom_form_endpoint: $ref: '#/components/schemas/SecuredEndpoint' scope_validators: type: object additionalProperties: false properties: application_endpoint: $ref: '#/components/schemas/SecuredEndpoint' owner_endpoint: $ref: '#/components/schemas/SecuredEndpoint' third_party_config: type: object additionalProperties: false properties: token_validation_requirement: type: string enum: - connected - active - custom authorize_endpoint: type: string token_endpoint: type: string introspection_endpoint: type: - object - 'null' additionalProperties: false required: - endpoint properties: endpoint: type: string tls_client_profile_url: type: - string - 'null' format: uri security: type: array items: type: string enum: - basic-auth basic_auth: type: object additionalProperties: false properties: request_headername: type: - string - 'null' username: type: string password: type: - string - 'null' custom_headername_format: type: string advanced_scope_security: type: object additionalProperties: false properties: enabled: type: boolean mode: type: array items: type: string enum: - basic-auth basic_auth: type: object additionalProperties: false properties: request_headername: type: string username: type: string password: type: - string - 'null' auth_header_pass_thru: type: boolean default: false introspect_cache_type: type: string default: no-cache enum: - no-cache - protocol - time-to-live introspect_cache_ttl: type: integer third_party_config_12000: type: object additionalProperties: false properties: oauth_specification: type: string enum: - oauth2.0 - oauth2.1 jwt_provider_url: type: string format: uri introspection_endpoint: type: - object - 'null' additionalProperties: false required: - endpoint properties: endpoint: type: string security: type: array items: type: string enum: - basic-auth basic_auth: type: object additionalProperties: false properties: body_credentials: type: - object - 'null' additionalProperties: false properties: id: type: string secret: type: - string - 'null' username: type: string password: type: - string - 'null' tls_client_profile_url: type: - string - 'null' format: uri version: type: - string - 'null' enum: - HTTP/1.0 - HTTP/1.1 - HTTP/2 timeout: type: - integer - 'null' persistent_connections: type: boolean compress_request: type: - string - 'null' enum: - br - gzip - deflate - none decompress_response: type: boolean chunked_upload: type: boolean follow_redirects: type: boolean third_party_config_13000: type: object additionalProperties: false properties: introspection_mode: type: string enum: - remote - local remote_introspection: type: object additionalProperties: false properties: gateway_user: type: string local_introspection: type: object additionalProperties: false properties: issuer: type: string jwks_uri: type: string use_local_clock_skew: type: boolean clock_skew_in_seconds: type: integer token_generator: type: object additionalProperties: false properties: access_token_exp_interval: type: integer auth_code_exp_interval: type: integer expiry: type: integer enforce_pkce: type: boolean algorithm: type: string refresh_token_url: type: string dcr: type: object additionalProperties: false properties: provider_name: type: string endpoint: type: string endpoint_headers: type: object additionalProperties: type: string auth_type: type: string enum: - basic - token - refresh_token - client_credentials - none username: type: - string - 'null' password: type: - string - 'null' token: type: - string - 'null' token_type: type: - string - 'null' client_id: type: - string - 'null' client_secret: type: - string - 'null' scope: type: - string - 'null' visibility: $ref: '#/components/schemas/ResourceVisibility' user_registry_urls: type: array items: type: string format: uri jwt_provider_urls: type: array items: type: string format: uri tls_client_profile_urls: type: array items: type: string format: uri configured_oauth_provider_urls: type: array items: type: string format: uri org_url: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri Keystore: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - keystore api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 key_name: type: - string - 'null' description: Name for the primary key+certificate pair, auto-generated from certificate or user-provided private_key_entry: type: string format: password public_certificate_entry: $ref: '#/components/schemas/CertEntry' public_key_jwk: $ref: '#/components/schemas/PublicKeyJwk' trusted_certificate_entries: type: array items: $ref: '#/components/schemas/CertEntry' key_entries: type: - array - 'null' description: Additional key+certificate pairs beyond the first (for multi-key keystores) items: type: object required: - key_name - private_key_entry - public_certificate_entry properties: key_name: type: string description: Name for this key+certificate pair, auto-generated from certificate CN or user-provided private_key_entry: type: string format: password description: Private key in PEM format public_certificate_entry: $ref: '#/components/schemas/CertEntry' trusted_certificate_entries: type: - array - 'null' items: $ref: '#/components/schemas/CertEntry' description: CA certificate chain for this key+certificate pair keystore: type: string password: type: string format: password tls_server_profile_urls: type: array items: type: string format: uri tls_client_profile_urls: type: array items: type: string format: uri cloud_setting_urls: type: array items: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri WatsonxSettings: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - watsonx_settings api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 scope: type: string org_id: type: string model_properties: type: object additionalProperties: true watsonxurl: type: string is_default: type: boolean default: false username: type: string password: type: string api_key: type: string token: type: string project_id: type: string space_id: type: string org: type: string credential_type: type: string enum: - ibm_managed - user_managed config_type: type: string enum: - cloud - software version: type: string instance_id: type: string auth_type: type: string enum: - iam - bearertoken - cp4d metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri Opentelemetry: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - opentelemetry api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 endpoints: type: array items: type: object properties: protocol: type: string enum: - grpc - http/protobuf - http/json default: grpc endpoint: type: string format: uri tls_client_profile_url: type: string signals: type: array uniqueItems: true items: type: string enum: - logs - traces required: - endpoint headers: type: array items: type: object properties: name: type: string value: type: string required: - name - value attributes: type: array items: type: object properties: name: type: string value: type: string required: - name - value batching: type: object properties: max-queue-size: type: integer batch-size: type: integer export-interval: type: integer export-timeout: type: integer max-threads: type: integer sampling: type: object properties: parent-based: type: boolean sampler-type: type: string enum: - always_off - always_on - trace_id_ratio_based sampler-ratio: type: integer minimum: 0 maximum: 100 gateway_service_urls: type: array items: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProjectMockEndpointV2: type: object required: - kind - apiVersion - metadata - spec additionalProperties: false properties: kind: enum: - MockEndpoint type: string apiVersion: type: string enum: - api.ibm.com/v2 metadata: $ref: '#/components/schemas/ProjectMetadata' spec: oneOf: - type: object additionalProperties: false required: - rest properties: rest: type: object additionalProperties: false properties: paths: type: object additionalProperties: type: object additionalProperties: false properties: get: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' post: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' put: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' patch: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' delete: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' head: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' options: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' trace: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' - type: object additionalProperties: false required: - soap properties: soap: type: object additionalProperties: false properties: operations: type: object additionalProperties: $ref: '#/components/schemas/ProjectMockEndpointMethodResponse' BillingList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Billing' Billing: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - billing api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 integration_url: type: string format: uri product_urls: type: array items: type: string format: uri configuration: type: object additionalProperties: type: string payment_method_type_urls: type: array items: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri Job: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - job api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 state: type: string enum: - ready - claimed - running - blocked - failed activity: type: array items: type: string error: type: string path: type: string enum: - subscription-update - subscription-delete - bulk-subscription-update - bulk-subscription-delete - payment-method-delete - payment-method-delete-consumer body: type: object additionalProperties: true generated_at: type: string processed_work: type: integer minimum: 0 maximum: 2147483647 processed_at: type: string format: date-time retries: type: integer minimum: 0 maximum: 2147483647 metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri Billing_2: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - billing api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 integration_url: type: string format: uri payment_method_integration_urls: type: array items: type: string format: uri configuration: type: object additionalProperties: type: string visibility: $ref: '#/components/schemas/ResourceVisibility' owned: type: boolean configured_billing_urls: type: array items: type: string format: uri custom_endpoint: $ref: '#/components/schemas/SecuredEndpoint' job_queue_status: type: object additionalProperties: false properties: queue_length: type: integer head_state: type: string head_error: type: string metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri JobList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Job' ProgrammingPackage: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - programming_package api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 version: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 programming_package: type: array items: type: object additionalProperties: false required: - file_content - file_name - mimetype properties: file_content: type: string format: binary file_name: type: string mimetype: type: string subpath: type: string programming_package_files: type: array items: type: object additionalProperties: false properties: file: type: string subpath: type: string programming_package_type: type: string enum: - lua configured_programming_package_urls: type: array items: type: string format: uri org_url: type: string format: uri metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri ProgrammingPackageMultipart: type: object properties: programming_package_files: type: array items: $ref: '#/components/schemas/ProgrammingPackageFile' ProgrammingPackageList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/ProgrammingPackage' ProgrammingPackageFile: type: object additionalProperties: false properties: file: type: string format: binary subpath: type: string parameters: oauth-provider: name: oauth-provider in: path description: Oauth Provider name or id required: true schema: type: string xslt-transformation-alias-id: name: xslt-transformation-alias-id in: path description: Xslt Transformation Alias name required: true schema: type: string policy-version: name: policy-version in: path description: Policy version name required: true schema: type: string tls-server-profile-version: name: tls-server-profile-version in: path description: TLS Server Profile version name required: true schema: type: string watsonx-settings: name: watsonx-settings in: path description: Watsonx Settings name or id required: true schema: type: string jwk-set: name: jwk-set in: path description: Jwk Set name or id required: true schema: type: string opentelemetry: name: opentelemetry in: path description: Opentelemetry name or id required: true schema: type: string extension-id: name: extension-id in: path description: Extension name required: true schema: type: string portal-service: name: portal-service in: path description: Portal Service name or id required: true schema: type: string policy-name: name: policy-name in: path description: Policy name required: true schema: type: string mail-server: name: mail-server in: path description: Mail Server name or id required: true schema: type: string tls-client-profile-version: name: tls-client-profile-version in: path description: TLS Client Profile version name required: true schema: type: string availability-zone: name: availability-zone in: path description: Availability Zone name or id required: true schema: type: string webmethods-is-service-alias-version: name: webmethods-is-service-alias-version in: path description: Webmethods Integration Server Service Alias version name required: true schema: type: string policy-id: name: policy-id in: path description: Policy name required: true schema: type: string jwt-provider: name: jwt-provider in: path description: Jwt Provider name or id required: true schema: type: string extension-version: name: extension-version in: path description: Extension version name required: true schema: type: string limit: name: limit in: query description: Maximum number of items to return required: false schema: type: integer http-transport-security-alias-id: name: http-transport-security-alias-id in: path description: Http Transport Security Alias name required: true schema: type: string webmethods-is-service-alias-name: name: webmethods-is-service-alias-name in: path description: Webmethods Integration Server Service Alias name required: true schema: type: string keystore: name: keystore in: path description: Keystore name or id required: true schema: type: string tls-client-profile-id: name: tls-client-profile-id in: path description: TLS Client Profile name required: true schema: type: string truststore: name: truststore in: path description: Truststore name or id required: true schema: type: string webmethods-is-service-alias-id: name: webmethods-is-service-alias-id in: path description: Webmethods Integration Server Service Alias name required: true schema: type: string entry: name: entry in: path description: Entry name or id required: true schema: type: string tls-server-profile-id: name: tls-server-profile-id in: path description: TLS Server Profile name required: true schema: type: string org: name: org in: path description: Organization name or id required: true schema: type: string fields: name: fields in: query description: List of field names to return required: false schema: type: string force: name: force in: query description: Force the operation required: false schema: type: boolean analytics-service: name: analytics-service in: path description: Analytics Service name or id required: true schema: type: string xslt-transformation-alias-version: name: xslt-transformation-alias-version in: path description: Xslt Transformation Alias version name required: true schema: type: string offset: name: offset in: query description: Offset item number from list to begin return required: false schema: type: integer gateway-service: name: gateway-service in: path description: Gateway Service name or id required: true schema: type: string tls-server-profile-name: name: tls-server-profile-name in: path description: TLS Server Profile name required: true schema: type: string confirm: name: confirm in: query description: Confirmation for critical updates required: true schema: type: string extension-name: name: extension-name in: path description: Extension name required: true schema: type: string tls-client-profile-name: name: tls-client-profile-name in: path description: TLS Client Profile name required: true schema: type: string cascade: name: cascade in: query description: Cascade the behavior required: false schema: type: boolean http-transport-security-alias-name: name: http-transport-security-alias-name in: path description: Http Transport Security Alias name required: true schema: type: string http-transport-security-alias-version: name: http-transport-security-alias-version in: path description: Http Transport Security Alias version name required: true schema: type: string xslt-transformation-alias-name: name: xslt-transformation-alias-name in: path description: Xslt Transformation Alias name required: true schema: type: string billing: name: billing in: path description: Billing name or id required: true schema: type: string fields_2: name: fields in: query description: field name required: false schema: type: string job: name: job in: path description: Job name or id required: true schema: type: string programming-package-id: name: programming-package-id in: path description: Programming Package name required: true schema: type: string programming-package-version: name: programming-package-version in: path description: Programming Package version name required: true schema: type: string programming-package-name: name: programming-package-name in: path description: Programming Package name required: true schema: type: string responses: Error: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' application/yaml: schema: $ref: '#/components/schemas/Error' securitySchemes: oauth: type: oauth2 flows: implicit: authorizationUrl: /oauth2/authorize scopes: api-drafts:edit: Clear the Draft objects, Create a Draft API object, Clear all Draft API objects in all collections, Clear the Draft API objects, Update the Draft API object by id, Delete the Draft API object by id, Update the Draft API object by name and version, Delete the Draft API object by name and version api-drafts:view: List the Draft objects, List all Draft API objects in all collections, List the Draft API objects, Get the Draft API object by id, Get the Draft API object by name and version app:manage:all: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Strategy object, Delete the Strategy object by name or id, Clear the Strategy objects, Update the Strategy object by name or id, Create a Application Credential object, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id app:view:all: List the Application objects, Get the Application object by name or id, List the Strategy objects, Get the Strategy object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id approval:view: List the Task objects, Get the Task object by name or id, Update the Task object by name or id, List the Task History objects, Get the Task History object by name or id child:create: Create a Catalog object, Create a Space object child:manage: Clear the Catalog objects, Update the Catalog object by name or id, Delete the Catalog object by name or id, Clear the Space objects, Update the Space object by name or id, Delete the Space object by name or id child:view: List the Catalog objects, Get the Catalog object by name or id, List the Space objects, Get the Space object by name or id cloud:manage: Update the Cloud Setting object, Update the User Registry Setting object, Update the Notification Style object, Create a Registration object, Clear the Registration objects, Update the Registration object by name or id, Delete the Registration object by name or id, Update the Webhook object by name or id cloud:view: Get the Cloud Setting object, Get the User Registry Setting object, Get the Notification Style object, List all Notification Template objects in all collections, List all Role Default objects in all collections, List the Registration objects, Get the Registration object by name or id, List the Webhook objects, Get the Webhook object by name or id consumer-org:manage: Clear the Activation objects, Delete the Activation object by name or id, Create a Consumer Organization object, Clear the Consumer Organization objects, Update the Consumer Organization object by name or id, Delete the Consumer Organization object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id consumer-org:view: List the Activation objects, Get the Activation object by name or id, List the Consumer Organization objects, Get the Consumer Organization object by name or id, List the Payment Method objects, Get the Payment Method object by name or id my:manage: Create a API Key object, Delete the API Key object by name or id, Update the Me object, Delete the Me object my:view: List the API Key objects, Get the API Key object by name or id, Get the Me object, List the My Permission objects, List the My Task objects, List the Originated Task objects, List the My Organization objects, List the My Catalog objects, List the My Space objects, List the My User Group objects, List the My Team objects org:manage: Update the Log Spec object, Create a User Registry object, Clear the User Registry objects, Update the User Registry object by name or id, Delete the User Registry object by name or id, Create a User object, Clear the User objects, Update the User object by name or id, Delete the User object by name or id, Update the Organization Setting object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Update the Member Invitation object by name or id, Delete the Member Invitation object by name or id, Create a Member object, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a User Group Role Assignment object, Clear the User Group Role Assignment objects, Update the User Group Role Assignment object by name or id, Delete the User Group Role Assignment object by name or id, Create a Role object, Clear the Role objects, Update the Role object by name or id, Delete the Role object by name or id, Create a Availability Zone object, Clear the Availability Zone objects, Update the Availability Zone object by name or id, Delete the Availability Zone object by name or id, Create a Gateway Service object, Clear the Gateway Service objects, Update the Gateway Service object by name or id, Delete the Gateway Service object by name or id, Create a Portal Service object, Clear the Portal Service objects, Update the Portal Service object by name or id, Delete the Portal Service object by name or id, Create a Analytics Service object, Clear the Analytics Service objects, Update the Analytics Service object by name or id, Delete the Analytics Service object by name or id, Create a Opentelemetry object, Clear the Opentelemetry objects, Update the Opentelemetry object by name or id, Delete the Opentelemetry object by name or id, Create a Oauth Provider object, Clear the Oauth Provider objects, Update the Oauth Provider object by name or id, Delete the Oauth Provider object by name or id, Create a Jwt Provider object, Clear the Jwt Provider objects, Update the Jwt Provider object by name or id, Delete the Jwt Provider object by name or id, Create a Mail Server object, Clear the Mail Server objects, Update the Mail Server object by name or id, Delete the Mail Server object by name or id, Create a Billing object, Clear the Billing objects, Update the Billing object by name or id, Delete the Billing object by name or id, Create a Itopsplatform object, Clear the Itopsplatform objects, Update the Itopsplatform object by name or id, Delete the Itopsplatform object by name or id, Clear the Job objects, Delete the Job object by name or id, Create a TLS Server Profile object, Clear all TLS Server Profile objects in all collections, Clear the TLS Server Profile objects, Update the TLS Server Profile object by id, Delete the TLS Server Profile object by id, Update the TLS Server Profile object by name and version, Delete the TLS Server Profile object by name and version, Create a TLS Client Profile object, Clear all TLS Client Profile objects in all collections, Clear the TLS Client Profile objects, Update the TLS Client Profile object by id, Delete the TLS Client Profile object by id, Update the TLS Client Profile object by name and version, Delete the TLS Client Profile object by name and version, Create a Keystore object, Clear the Keystore objects, Update the Keystore object by name or id, Delete the Keystore object by name or id, Create a Truststore object, Clear the Truststore objects, Update the Truststore object by name or id, Delete the Truststore object by name or id, Create a Entry object, Clear the Entry objects, Update the Entry object by name or id, Delete the Entry object by name or id, Create a Jwk Set object, Clear the Jwk Set objects, Delete the Jwk Set object by name or id, Create a Programming Package object, Clear the Programming Package objects, Clear all Programming Package objects in all collections, Update the Programming Package object by id, Update the Programming Package object by name and version, Delete the Programming Package object by id, Delete the Programming Package object by name and version, List all Alias objects in all collections, Clear all Alias objects in all collections, Create a Xslt Transformation Alias object, Clear the Xslt Transformation Alias objects, Clear all Xslt Transformation Alias objects in all collections, Update the Xslt Transformation Alias object by id, Update the Xslt Transformation Alias object by name and version, Delete the Xslt Transformation Alias object by id, Delete the Xslt Transformation Alias object by name and version, Create a Http Transport Security Alias object, Clear the Http Transport Security Alias objects, Clear all Http Transport Security Alias objects in all collections, Update the Http Transport Security Alias object by id, Update the Http Transport Security Alias object by name and version, Delete the Http Transport Security Alias object by id, Delete the Http Transport Security Alias object by name and version, Create a Webmethods Integration Server Service Alias object, Clear the Webmethods Integration Server Service Alias objects, Clear all Webmethods Integration Server Service Alias objects in all collections, Update the Webmethods Integration Server Service Alias object by id, Update the Webmethods Integration Server Service Alias object by name and version, Delete the Webmethods Integration Server Service Alias object by id, Delete the Webmethods Integration Server Service Alias object by name and version, Update the Catalog Setting object, Create a Configured Gateway Service object, Clear the Configured Gateway Service objects, Delete the Configured Gateway Service object by name or id, Create a Configured Catalog User Registry object, Delete the Configured Catalog User Registry object by name or id, Create a Configured API User Registry object, Clear the Configured API User Registry objects, Delete the Configured API User Registry object by name or id, Create a Configured TLS Client Profile object, Clear the Configured TLS Client Profile objects, Delete the Configured TLS Client Profile object by id, Delete the Configured TLS Client Profile object by name and version, Create a Configured Billing object, Clear the Configured Billing objects, Delete the Configured Billing object by name or id, Create a Configured Jwt Provider object, Clear the Configured Jwt Provider objects, Delete the Configured Jwt Provider object by name or id, Create a Configured Oauth Provider object, Clear the Configured Oauth Provider objects, Delete the Configured Oauth Provider object by name or id, Create a Configured Portal Service object, Clear the Configured Portal Service objects, Delete the Configured Portal Service object by name or id, Create a Configured Programming Package object, Clear the Configured Programming Package objects, Delete the Configured Programming Package object by id, Delete the Configured Programming Package object by name and version, List all Configured Alias objects in all collections, Clear all Configured Alias objects in all collections, Create a Configured Xslt Transformation Alias object, Clear the Configured Xslt Transformation Alias objects, Clear all Configured Xslt Transformation Alias objects in all collections, Delete the Configured Xslt Transformation Alias object by id, Delete the Configured Xslt Transformation Alias object by name and version, Create a Configured Webmethods Integration Server Service Alias object, Clear the Configured Webmethods Integration Server Service Alias objects, Clear all Configured Webmethods Integration Server Service Alias objects in all collections, Delete the Configured Webmethods Integration Server Service Alias object by id, Delete the Configured Webmethods Integration Server Service Alias object by name and version, Create a Configured Http Transport Security Alias object, Clear the Configured Http Transport Security Alias objects, Clear all Configured Http Transport Security Alias objects in all collections, Delete the Configured Http Transport Security Alias object by id, Delete the Configured Http Transport Security Alias object by name and version, Augment the Configuration Property with additional name/value pairs, Clear the Configuration Property objects, Update the Configuration Property object, Delete the Configuration Property object, Create a Global Policy object, Clear all Global Policy objects in all collections, Clear the Global Policy objects, Update the Global Policy object by id, Delete the Global Policy object by id, Update the Global Policy object by name and version, Delete the Global Policy object by name and version, Create the Global Policy Error object, Update the Global Policy Error object, Delete the Global Policy Error object, Create the Global Policy Prehook object, Update the Global Policy Prehook object, Delete the Global Policy Prehook object, Create the Global Policy Posthook object, Update the Global Policy Posthook object, Delete the Global Policy Posthook object, Create a Simple Alias object, Clear the Simple Alias objects, Update the Simple Alias object by name or id, Delete the Simple Alias object by name or id, Update the Space Setting object, Update the Consumer Organization Setting object, Delete the Consumer Organization Setting object, Create a Watsonx Settings object, Update the Watsonx Settings object by name or id, Delete the Watsonx Settings object by name or id org:view: Get the Log Spec object, List the User Registry objects, Get the User Registry object by name or id, List the User objects, Get the User object by name or id, List all Integration objects in all collections, Get the Organization Setting object, Get the Organization object by name or id, List the Associate objects, Get the Associate object by name or id, Create a User Group object, List the User Group objects, Clear the User Group objects, Get the User Group object by name or id, Update the User Group object by name or id, Delete the User Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the Member objects, Get the Member object by name or id, List the User Group Role Assignment objects, Get the User Group Role Assignment object by name or id, List all Permission objects in all collections, List the Role objects, Get the Role object by name or id, Create a Team object, List the Team objects, Clear the Team objects, Get the Team object by name or id, Update the Team object by name or id, Delete the Team object by name or id, List the Availability Zone objects, Get the Availability Zone object by name or id, List the Gateway Service objects, Get the Gateway Service object by name or id, List all Policy objects in all collections, List the Policy objects, Get the Policy object by id, Get the Policy object by name and version, List all Extension objects in all collections, List the Extension objects, Get the Extension object by id, Get the Extension object by name and version, Create the Gateway Extension object, Get the Gateway Extension object, Update the Gateway Extension object, Delete the Gateway Extension object, List the Portal Service objects, Get the Portal Service object by name or id, List the Analytics Service objects, Get the Analytics Service object by name or id, List the Opentelemetry objects, Get the Opentelemetry object by name or id, List the Oauth Provider objects, Get the Oauth Provider object by name or id, List the Jwt Provider objects, Get the Jwt Provider object by name or id, List the Mail Server objects, Get the Mail Server object by name or id, List the Billing objects, Get the Billing object by name or id, List the Itopsplatform objects, Get the Itopsplatform object by name or id, List the Job objects, Get the Job object by name or id, List all TLS Server Profile objects in all collections, List the TLS Server Profile objects, Get the TLS Server Profile object by id, Get the TLS Server Profile object by name and version, List all TLS Client Profile objects in all collections, List the TLS Client Profile objects, Get the TLS Client Profile object by id, Get the TLS Client Profile object by name and version, List the Keystore objects, Get the Keystore object by name or id, List the Truststore objects, Get the Truststore object by name or id, List the Entry objects, Get the Entry object by name or id, List the Jwk Set objects, Get the Jwk Set object by name or id, List the Programming Package objects, List all Programming Package objects in all collections, Get the Programming Package object by id, Get the Programming Package object by name and version, List the Xslt Transformation Alias objects, List all Xslt Transformation Alias objects in all collections, Get the Xslt Transformation Alias object by id, Get the Xslt Transformation Alias object by name and version, List the Http Transport Security Alias objects, List all Http Transport Security Alias objects in all collections, Get the Http Transport Security Alias object by id, Get the Http Transport Security Alias object by name and version, List the Webmethods Integration Server Service Alias objects, List all Webmethods Integration Server Service Alias objects in all collections, Get the Webmethods Integration Server Service Alias object by id, Get the Webmethods Integration Server Service Alias object by name and version, Get the Catalog Setting object, List the Configured Gateway Service objects, Get the Configured Gateway Service object by name or id, List the Configured Catalog User Registry objects, Get the Configured Catalog User Registry object by name or id, List the Configured API User Registry objects, Get the Configured API User Registry object by name or id, List all Configured TLS Client Profile objects in all collections, Clear all Configured TLS Client Profile objects in all collections, List the Configured TLS Client Profile objects, Get the Configured TLS Client Profile object by id, Get the Configured TLS Client Profile object by name and version, List the Configured Billing objects, Get the Configured Billing object by name or id, List the Configured Jwt Provider objects, Get the Configured Jwt Provider object by name or id, List the Configured Oauth Provider objects, Get the Configured Oauth Provider object by name or id, List the Configured Portal Service objects, Get the Configured Portal Service object by name or id, List the Configured Programming Package objects, List all Configured Programming Package objects in all collections, Clear all Configured Programming Package objects in all collections, Get the Configured Programming Package object by id, Get the Configured Programming Package object by name and version, List the Configured Xslt Transformation Alias objects, List all Configured Xslt Transformation Alias objects in all collections, Get the Configured Xslt Transformation Alias object by id, Get the Configured Xslt Transformation Alias object by name and version, List the Configured Webmethods Integration Server Service Alias objects, List all Configured Webmethods Integration Server Service Alias objects in all collections, Get the Configured Webmethods Integration Server Service Alias object by id, Get the Configured Webmethods Integration Server Service Alias object by name and version, List the Configured Http Transport Security Alias objects, List all Configured Http Transport Security Alias objects in all collections, Get the Configured Http Transport Security Alias object by id, Get the Configured Http Transport Security Alias object by name and version, List the Configuration Property objects, Get the Configuration Property object, List all Global Policy objects in all collections, List the Global Policy objects, Get the Global Policy object by id, Get the Global Policy object by name and version, Get the Global Policy Error object, Get the Global Policy Prehook object, Get the Global Policy Posthook object, List the Simple Alias objects, Get the Simple Alias object by name or id, Get the Space Setting object, Get the Consumer Organization Setting object, List the Primary Event objects, Get the Primary Event object by name or id, List the Subscriber Event objects, Get the Subscriber Event object by name or id, List the Task Queue objects, Get the Task Queue object by name or id, List the Watsonx Settings objects, Get the Watsonx Settings object by name or id, List the Resource Service Status objects product-drafts:edit: Create a Draft Product object, Clear all Draft Product objects in all collections, Clear the Draft Product objects, Update the Draft Product object by id, Delete the Draft Product object by id, Update the Draft Product object by name and version, Delete the Draft Product object by name and version product-drafts:view: List all Draft Product objects in all collections, List the Draft Product objects, Get the Draft Product object by id, Get the Draft Product object by name and version product:manage: Clear all Product objects in all collections, Clear the Product objects, Update the Product object by id, Delete the Product object by id, Update the Product object by name and version, Delete the Product object by name and version, Update the API object by id, Update the API object by name and version product:view: List all Product objects in all collections, List the Product objects, Get the Product object by id, Get the Product object by name and version, List all API objects in all collections, List the API objects, Get the API object by id, Get the API object by name and version, Get the Plan object by id, Get the Plan object by name and version, List the Plan objects, List all Plan objects in all collections, Get the Quota object by id, Get the Quota object by name and version, List the Quota objects, List all Quota objects in all collections project:manage: Create a Project object, Clear the Project objects, Update the Project object by name or id, Delete the Project object by name or id, Clear the Project File objects, Clear all Project File objects in all collections, Update the Project File object by id, Update the Project File object by name and version, Delete the Project File object by id, Delete the Project File object by name and version project:view: List the Project objects, Get the Project object by name or id, List the Project File objects, List all Project File objects in all collections, Get the Project File object by id, Get the Project File object by name and version provider-org:manage: Create an Organization Invitation object, Clear the Organization Invitation objects, Update the Organization Invitation object by name or id, Delete the Organization Invitation object by name or id, Create a Group object, Clear the Group objects, Update the Group object by name or id, Delete the Group object by name or id provider-org:view: List the Organization Invitation objects, Get the Organization Invitation object by name or id, List the Group objects, Get the Group object by name or id webhook:manage: Update the Webhook object by name or id webhook:view: List the Webhook objects, Get the Webhook object by name or id password: tokenUrl: /token refreshUrl: /token scopes: api-drafts:edit: Clear the Draft objects, Create a Draft API object, Clear all Draft API objects in all collections, Clear the Draft API objects, Update the Draft API object by id, Delete the Draft API object by id, Update the Draft API object by name and version, Delete the Draft API object by name and version api-drafts:view: List the Draft objects, List all Draft API objects in all collections, List the Draft API objects, Get the Draft API object by id, Get the Draft API object by name and version app:manage:all: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Strategy object, Delete the Strategy object by name or id, Clear the Strategy objects, Update the Strategy object by name or id, Create a Application Credential object, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id app:view:all: List the Application objects, Get the Application object by name or id, List the Strategy objects, Get the Strategy object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id approval:view: List the Task objects, Get the Task object by name or id, Update the Task object by name or id, List the Task History objects, Get the Task History object by name or id child:create: Create a Catalog object, Create a Space object child:manage: Clear the Catalog objects, Update the Catalog object by name or id, Delete the Catalog object by name or id, Clear the Space objects, Update the Space object by name or id, Delete the Space object by name or id child:view: List the Catalog objects, Get the Catalog object by name or id, List the Space objects, Get the Space object by name or id cloud:manage: Update the Cloud Setting object, Update the User Registry Setting object, Update the Notification Style object, Create a Registration object, Clear the Registration objects, Update the Registration object by name or id, Delete the Registration object by name or id, Update the Webhook object by name or id cloud:view: Get the Cloud Setting object, Get the User Registry Setting object, Get the Notification Style object, List all Notification Template objects in all collections, List all Role Default objects in all collections, List the Registration objects, Get the Registration object by name or id, List the Webhook objects, Get the Webhook object by name or id consumer-org:manage: Clear the Activation objects, Delete the Activation object by name or id, Create a Consumer Organization object, Clear the Consumer Organization objects, Update the Consumer Organization object by name or id, Delete the Consumer Organization object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id consumer-org:view: List the Activation objects, Get the Activation object by name or id, List the Consumer Organization objects, Get the Consumer Organization object by name or id, List the Payment Method objects, Get the Payment Method object by name or id my:manage: Create a API Key object, Delete the API Key object by name or id, Update the Me object, Delete the Me object my:view: List the API Key objects, Get the API Key object by name or id, Get the Me object, List the My Permission objects, List the My Task objects, List the Originated Task objects, List the My Organization objects, List the My Catalog objects, List the My Space objects, List the My User Group objects, List the My Team objects org:manage: Update the Log Spec object, Create a User Registry object, Clear the User Registry objects, Update the User Registry object by name or id, Delete the User Registry object by name or id, Create a User object, Clear the User objects, Update the User object by name or id, Delete the User object by name or id, Update the Organization Setting object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Update the Member Invitation object by name or id, Delete the Member Invitation object by name or id, Create a Member object, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a User Group Role Assignment object, Clear the User Group Role Assignment objects, Update the User Group Role Assignment object by name or id, Delete the User Group Role Assignment object by name or id, Create a Role object, Clear the Role objects, Update the Role object by name or id, Delete the Role object by name or id, Create a Availability Zone object, Clear the Availability Zone objects, Update the Availability Zone object by name or id, Delete the Availability Zone object by name or id, Create a Gateway Service object, Clear the Gateway Service objects, Update the Gateway Service object by name or id, Delete the Gateway Service object by name or id, Create a Portal Service object, Clear the Portal Service objects, Update the Portal Service object by name or id, Delete the Portal Service object by name or id, Create a Analytics Service object, Clear the Analytics Service objects, Update the Analytics Service object by name or id, Delete the Analytics Service object by name or id, Create a Opentelemetry object, Clear the Opentelemetry objects, Update the Opentelemetry object by name or id, Delete the Opentelemetry object by name or id, Create a Oauth Provider object, Clear the Oauth Provider objects, Update the Oauth Provider object by name or id, Delete the Oauth Provider object by name or id, Create a Jwt Provider object, Clear the Jwt Provider objects, Update the Jwt Provider object by name or id, Delete the Jwt Provider object by name or id, Create a Mail Server object, Clear the Mail Server objects, Update the Mail Server object by name or id, Delete the Mail Server object by name or id, Create a Billing object, Clear the Billing objects, Update the Billing object by name or id, Delete the Billing object by name or id, Create a Itopsplatform object, Clear the Itopsplatform objects, Update the Itopsplatform object by name or id, Delete the Itopsplatform object by name or id, Clear the Job objects, Delete the Job object by name or id, Create a TLS Server Profile object, Clear all TLS Server Profile objects in all collections, Clear the TLS Server Profile objects, Update the TLS Server Profile object by id, Delete the TLS Server Profile object by id, Update the TLS Server Profile object by name and version, Delete the TLS Server Profile object by name and version, Create a TLS Client Profile object, Clear all TLS Client Profile objects in all collections, Clear the TLS Client Profile objects, Update the TLS Client Profile object by id, Delete the TLS Client Profile object by id, Update the TLS Client Profile object by name and version, Delete the TLS Client Profile object by name and version, Create a Keystore object, Clear the Keystore objects, Update the Keystore object by name or id, Delete the Keystore object by name or id, Create a Truststore object, Clear the Truststore objects, Update the Truststore object by name or id, Delete the Truststore object by name or id, Create a Entry object, Clear the Entry objects, Update the Entry object by name or id, Delete the Entry object by name or id, Create a Jwk Set object, Clear the Jwk Set objects, Delete the Jwk Set object by name or id, Create a Programming Package object, Clear the Programming Package objects, Clear all Programming Package objects in all collections, Update the Programming Package object by id, Update the Programming Package object by name and version, Delete the Programming Package object by id, Delete the Programming Package object by name and version, List all Alias objects in all collections, Clear all Alias objects in all collections, Create a Xslt Transformation Alias object, Clear the Xslt Transformation Alias objects, Clear all Xslt Transformation Alias objects in all collections, Update the Xslt Transformation Alias object by id, Update the Xslt Transformation Alias object by name and version, Delete the Xslt Transformation Alias object by id, Delete the Xslt Transformation Alias object by name and version, Create a Http Transport Security Alias object, Clear the Http Transport Security Alias objects, Clear all Http Transport Security Alias objects in all collections, Update the Http Transport Security Alias object by id, Update the Http Transport Security Alias object by name and version, Delete the Http Transport Security Alias object by id, Delete the Http Transport Security Alias object by name and version, Create a Webmethods Integration Server Service Alias object, Clear the Webmethods Integration Server Service Alias objects, Clear all Webmethods Integration Server Service Alias objects in all collections, Update the Webmethods Integration Server Service Alias object by id, Update the Webmethods Integration Server Service Alias object by name and version, Delete the Webmethods Integration Server Service Alias object by id, Delete the Webmethods Integration Server Service Alias object by name and version, Update the Catalog Setting object, Create a Configured Gateway Service object, Clear the Configured Gateway Service objects, Delete the Configured Gateway Service object by name or id, Create a Configured Catalog User Registry object, Delete the Configured Catalog User Registry object by name or id, Create a Configured API User Registry object, Clear the Configured API User Registry objects, Delete the Configured API User Registry object by name or id, Create a Configured TLS Client Profile object, Clear the Configured TLS Client Profile objects, Delete the Configured TLS Client Profile object by id, Delete the Configured TLS Client Profile object by name and version, Create a Configured Billing object, Clear the Configured Billing objects, Delete the Configured Billing object by name or id, Create a Configured Jwt Provider object, Clear the Configured Jwt Provider objects, Delete the Configured Jwt Provider object by name or id, Create a Configured Oauth Provider object, Clear the Configured Oauth Provider objects, Delete the Configured Oauth Provider object by name or id, Create a Configured Portal Service object, Clear the Configured Portal Service objects, Delete the Configured Portal Service object by name or id, Create a Configured Programming Package object, Clear the Configured Programming Package objects, Delete the Configured Programming Package object by id, Delete the Configured Programming Package object by name and version, List all Configured Alias objects in all collections, Clear all Configured Alias objects in all collections, Create a Configured Xslt Transformation Alias object, Clear the Configured Xslt Transformation Alias objects, Clear all Configured Xslt Transformation Alias objects in all collections, Delete the Configured Xslt Transformation Alias object by id, Delete the Configured Xslt Transformation Alias object by name and version, Create a Configured Webmethods Integration Server Service Alias object, Clear the Configured Webmethods Integration Server Service Alias objects, Clear all Configured Webmethods Integration Server Service Alias objects in all collections, Delete the Configured Webmethods Integration Server Service Alias object by id, Delete the Configured Webmethods Integration Server Service Alias object by name and version, Create a Configured Http Transport Security Alias object, Clear the Configured Http Transport Security Alias objects, Clear all Configured Http Transport Security Alias objects in all collections, Delete the Configured Http Transport Security Alias object by id, Delete the Configured Http Transport Security Alias object by name and version, Augment the Configuration Property with additional name/value pairs, Clear the Configuration Property objects, Update the Configuration Property object, Delete the Configuration Property object, Create a Global Policy object, Clear all Global Policy objects in all collections, Clear the Global Policy objects, Update the Global Policy object by id, Delete the Global Policy object by id, Update the Global Policy object by name and version, Delete the Global Policy object by name and version, Create the Global Policy Error object, Update the Global Policy Error object, Delete the Global Policy Error object, Create the Global Policy Prehook object, Update the Global Policy Prehook object, Delete the Global Policy Prehook object, Create the Global Policy Posthook object, Update the Global Policy Posthook object, Delete the Global Policy Posthook object, Create a Simple Alias object, Clear the Simple Alias objects, Update the Simple Alias object by name or id, Delete the Simple Alias object by name or id, Update the Space Setting object, Update the Consumer Organization Setting object, Delete the Consumer Organization Setting object, Create a Watsonx Settings object, Update the Watsonx Settings object by name or id, Delete the Watsonx Settings object by name or id org:view: Get the Log Spec object, List the User Registry objects, Get the User Registry object by name or id, List the User objects, Get the User object by name or id, List all Integration objects in all collections, Get the Organization Setting object, Get the Organization object by name or id, List the Associate objects, Get the Associate object by name or id, Create a User Group object, List the User Group objects, Clear the User Group objects, Get the User Group object by name or id, Update the User Group object by name or id, Delete the User Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the Member objects, Get the Member object by name or id, List the User Group Role Assignment objects, Get the User Group Role Assignment object by name or id, List all Permission objects in all collections, List the Role objects, Get the Role object by name or id, Create a Team object, List the Team objects, Clear the Team objects, Get the Team object by name or id, Update the Team object by name or id, Delete the Team object by name or id, List the Availability Zone objects, Get the Availability Zone object by name or id, List the Gateway Service objects, Get the Gateway Service object by name or id, List all Policy objects in all collections, List the Policy objects, Get the Policy object by id, Get the Policy object by name and version, List all Extension objects in all collections, List the Extension objects, Get the Extension object by id, Get the Extension object by name and version, Create the Gateway Extension object, Get the Gateway Extension object, Update the Gateway Extension object, Delete the Gateway Extension object, List the Portal Service objects, Get the Portal Service object by name or id, List the Analytics Service objects, Get the Analytics Service object by name or id, List the Opentelemetry objects, Get the Opentelemetry object by name or id, List the Oauth Provider objects, Get the Oauth Provider object by name or id, List the Jwt Provider objects, Get the Jwt Provider object by name or id, List the Mail Server objects, Get the Mail Server object by name or id, List the Billing objects, Get the Billing object by name or id, List the Itopsplatform objects, Get the Itopsplatform object by name or id, List the Job objects, Get the Job object by name or id, List all TLS Server Profile objects in all collections, List the TLS Server Profile objects, Get the TLS Server Profile object by id, Get the TLS Server Profile object by name and version, List all TLS Client Profile objects in all collections, List the TLS Client Profile objects, Get the TLS Client Profile object by id, Get the TLS Client Profile object by name and version, List the Keystore objects, Get the Keystore object by name or id, List the Truststore objects, Get the Truststore object by name or id, List the Entry objects, Get the Entry object by name or id, List the Jwk Set objects, Get the Jwk Set object by name or id, List the Programming Package objects, List all Programming Package objects in all collections, Get the Programming Package object by id, Get the Programming Package object by name and version, List the Xslt Transformation Alias objects, List all Xslt Transformation Alias objects in all collections, Get the Xslt Transformation Alias object by id, Get the Xslt Transformation Alias object by name and version, List the Http Transport Security Alias objects, List all Http Transport Security Alias objects in all collections, Get the Http Transport Security Alias object by id, Get the Http Transport Security Alias object by name and version, List the Webmethods Integration Server Service Alias objects, List all Webmethods Integration Server Service Alias objects in all collections, Get the Webmethods Integration Server Service Alias object by id, Get the Webmethods Integration Server Service Alias object by name and version, Get the Catalog Setting object, List the Configured Gateway Service objects, Get the Configured Gateway Service object by name or id, List the Configured Catalog User Registry objects, Get the Configured Catalog User Registry object by name or id, List the Configured API User Registry objects, Get the Configured API User Registry object by name or id, List all Configured TLS Client Profile objects in all collections, Clear all Configured TLS Client Profile objects in all collections, List the Configured TLS Client Profile objects, Get the Configured TLS Client Profile object by id, Get the Configured TLS Client Profile object by name and version, List the Configured Billing objects, Get the Configured Billing object by name or id, List the Configured Jwt Provider objects, Get the Configured Jwt Provider object by name or id, List the Configured Oauth Provider objects, Get the Configured Oauth Provider object by name or id, List the Configured Portal Service objects, Get the Configured Portal Service object by name or id, List the Configured Programming Package objects, List all Configured Programming Package objects in all collections, Clear all Configured Programming Package objects in all collections, Get the Configured Programming Package object by id, Get the Configured Programming Package object by name and version, List the Configured Xslt Transformation Alias objects, List all Configured Xslt Transformation Alias objects in all collections, Get the Configured Xslt Transformation Alias object by id, Get the Configured Xslt Transformation Alias object by name and version, List the Configured Webmethods Integration Server Service Alias objects, List all Configured Webmethods Integration Server Service Alias objects in all collections, Get the Configured Webmethods Integration Server Service Alias object by id, Get the Configured Webmethods Integration Server Service Alias object by name and version, List the Configured Http Transport Security Alias objects, List all Configured Http Transport Security Alias objects in all collections, Get the Configured Http Transport Security Alias object by id, Get the Configured Http Transport Security Alias object by name and version, List the Configuration Property objects, Get the Configuration Property object, List all Global Policy objects in all collections, List the Global Policy objects, Get the Global Policy object by id, Get the Global Policy object by name and version, Get the Global Policy Error object, Get the Global Policy Prehook object, Get the Global Policy Posthook object, List the Simple Alias objects, Get the Simple Alias object by name or id, Get the Space Setting object, Get the Consumer Organization Setting object, List the Primary Event objects, Get the Primary Event object by name or id, List the Subscriber Event objects, Get the Subscriber Event object by name or id, List the Task Queue objects, Get the Task Queue object by name or id, List the Watsonx Settings objects, Get the Watsonx Settings object by name or id, List the Resource Service Status objects product-drafts:edit: Create a Draft Product object, Clear all Draft Product objects in all collections, Clear the Draft Product objects, Update the Draft Product object by id, Delete the Draft Product object by id, Update the Draft Product object by name and version, Delete the Draft Product object by name and version product-drafts:view: List all Draft Product objects in all collections, List the Draft Product objects, Get the Draft Product object by id, Get the Draft Product object by name and version product:manage: Clear all Product objects in all collections, Clear the Product objects, Update the Product object by id, Delete the Product object by id, Update the Product object by name and version, Delete the Product object by name and version, Update the API object by id, Update the API object by name and version product:view: List all Product objects in all collections, List the Product objects, Get the Product object by id, Get the Product object by name and version, List all API objects in all collections, List the API objects, Get the API object by id, Get the API object by name and version, Get the Plan object by id, Get the Plan object by name and version, List the Plan objects, List all Plan objects in all collections, Get the Quota object by id, Get the Quota object by name and version, List the Quota objects, List all Quota objects in all collections project:manage: Create a Project object, Clear the Project objects, Update the Project object by name or id, Delete the Project object by name or id, Clear the Project File objects, Clear all Project File objects in all collections, Update the Project File object by id, Update the Project File object by name and version, Delete the Project File object by id, Delete the Project File object by name and version project:view: List the Project objects, Get the Project object by name or id, List the Project File objects, List all Project File objects in all collections, Get the Project File object by id, Get the Project File object by name and version provider-org:manage: Create an Organization Invitation object, Clear the Organization Invitation objects, Update the Organization Invitation object by name or id, Delete the Organization Invitation object by name or id, Create a Group object, Clear the Group objects, Update the Group object by name or id, Delete the Group object by name or id provider-org:view: List the Organization Invitation objects, Get the Organization Invitation object by name or id, List the Group objects, Get the Group object by name or id webhook:manage: Update the Webhook object by name or id webhook:view: List the Webhook objects, Get the Webhook object by name or id clientCredentials: tokenUrl: /token scopes: api-drafts:edit: Clear the Draft objects, Create a Draft API object, Clear all Draft API objects in all collections, Clear the Draft API objects, Update the Draft API object by id, Delete the Draft API object by id, Update the Draft API object by name and version, Delete the Draft API object by name and version api-drafts:view: List the Draft objects, List all Draft API objects in all collections, List the Draft API objects, Get the Draft API object by id, Get the Draft API object by name and version app:manage:all: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Strategy object, Delete the Strategy object by name or id, Clear the Strategy objects, Update the Strategy object by name or id, Create a Application Credential object, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id app:view:all: List the Application objects, Get the Application object by name or id, List the Strategy objects, Get the Strategy object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id approval:view: List the Task objects, Get the Task object by name or id, Update the Task object by name or id, List the Task History objects, Get the Task History object by name or id child:create: Create a Catalog object, Create a Space object child:manage: Clear the Catalog objects, Update the Catalog object by name or id, Delete the Catalog object by name or id, Clear the Space objects, Update the Space object by name or id, Delete the Space object by name or id child:view: List the Catalog objects, Get the Catalog object by name or id, List the Space objects, Get the Space object by name or id cloud:manage: Update the Cloud Setting object, Update the User Registry Setting object, Update the Notification Style object, Create a Registration object, Clear the Registration objects, Update the Registration object by name or id, Delete the Registration object by name or id, Update the Webhook object by name or id cloud:view: Get the Cloud Setting object, Get the User Registry Setting object, Get the Notification Style object, List all Notification Template objects in all collections, List all Role Default objects in all collections, List the Registration objects, Get the Registration object by name or id, List the Webhook objects, Get the Webhook object by name or id consumer-org:manage: Clear the Activation objects, Delete the Activation object by name or id, Create a Consumer Organization object, Clear the Consumer Organization objects, Update the Consumer Organization object by name or id, Delete the Consumer Organization object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id consumer-org:view: List the Activation objects, Get the Activation object by name or id, List the Consumer Organization objects, Get the Consumer Organization object by name or id, List the Payment Method objects, Get the Payment Method object by name or id my:manage: Create a API Key object, Delete the API Key object by name or id, Update the Me object, Delete the Me object my:view: List the API Key objects, Get the API Key object by name or id, Get the Me object, List the My Permission objects, List the My Task objects, List the Originated Task objects, List the My Organization objects, List the My Catalog objects, List the My Space objects, List the My User Group objects, List the My Team objects org:manage: Update the Log Spec object, Create a User Registry object, Clear the User Registry objects, Update the User Registry object by name or id, Delete the User Registry object by name or id, Create a User object, Clear the User objects, Update the User object by name or id, Delete the User object by name or id, Update the Organization Setting object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Update the Member Invitation object by name or id, Delete the Member Invitation object by name or id, Create a Member object, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a User Group Role Assignment object, Clear the User Group Role Assignment objects, Update the User Group Role Assignment object by name or id, Delete the User Group Role Assignment object by name or id, Create a Role object, Clear the Role objects, Update the Role object by name or id, Delete the Role object by name or id, Create a Availability Zone object, Clear the Availability Zone objects, Update the Availability Zone object by name or id, Delete the Availability Zone object by name or id, Create a Gateway Service object, Clear the Gateway Service objects, Update the Gateway Service object by name or id, Delete the Gateway Service object by name or id, Create a Portal Service object, Clear the Portal Service objects, Update the Portal Service object by name or id, Delete the Portal Service object by name or id, Create a Analytics Service object, Clear the Analytics Service objects, Update the Analytics Service object by name or id, Delete the Analytics Service object by name or id, Create a Opentelemetry object, Clear the Opentelemetry objects, Update the Opentelemetry object by name or id, Delete the Opentelemetry object by name or id, Create a Oauth Provider object, Clear the Oauth Provider objects, Update the Oauth Provider object by name or id, Delete the Oauth Provider object by name or id, Create a Jwt Provider object, Clear the Jwt Provider objects, Update the Jwt Provider object by name or id, Delete the Jwt Provider object by name or id, Create a Mail Server object, Clear the Mail Server objects, Update the Mail Server object by name or id, Delete the Mail Server object by name or id, Create a Billing object, Clear the Billing objects, Update the Billing object by name or id, Delete the Billing object by name or id, Create a Itopsplatform object, Clear the Itopsplatform objects, Update the Itopsplatform object by name or id, Delete the Itopsplatform object by name or id, Clear the Job objects, Delete the Job object by name or id, Create a TLS Server Profile object, Clear all TLS Server Profile objects in all collections, Clear the TLS Server Profile objects, Update the TLS Server Profile object by id, Delete the TLS Server Profile object by id, Update the TLS Server Profile object by name and version, Delete the TLS Server Profile object by name and version, Create a TLS Client Profile object, Clear all TLS Client Profile objects in all collections, Clear the TLS Client Profile objects, Update the TLS Client Profile object by id, Delete the TLS Client Profile object by id, Update the TLS Client Profile object by name and version, Delete the TLS Client Profile object by name and version, Create a Keystore object, Clear the Keystore objects, Update the Keystore object by name or id, Delete the Keystore object by name or id, Create a Truststore object, Clear the Truststore objects, Update the Truststore object by name or id, Delete the Truststore object by name or id, Create a Entry object, Clear the Entry objects, Update the Entry object by name or id, Delete the Entry object by name or id, Create a Jwk Set object, Clear the Jwk Set objects, Delete the Jwk Set object by name or id, Create a Programming Package object, Clear the Programming Package objects, Clear all Programming Package objects in all collections, Update the Programming Package object by id, Update the Programming Package object by name and version, Delete the Programming Package object by id, Delete the Programming Package object by name and version, List all Alias objects in all collections, Clear all Alias objects in all collections, Create a Xslt Transformation Alias object, Clear the Xslt Transformation Alias objects, Clear all Xslt Transformation Alias objects in all collections, Update the Xslt Transformation Alias object by id, Update the Xslt Transformation Alias object by name and version, Delete the Xslt Transformation Alias object by id, Delete the Xslt Transformation Alias object by name and version, Create a Http Transport Security Alias object, Clear the Http Transport Security Alias objects, Clear all Http Transport Security Alias objects in all collections, Update the Http Transport Security Alias object by id, Update the Http Transport Security Alias object by name and version, Delete the Http Transport Security Alias object by id, Delete the Http Transport Security Alias object by name and version, Create a Webmethods Integration Server Service Alias object, Clear the Webmethods Integration Server Service Alias objects, Clear all Webmethods Integration Server Service Alias objects in all collections, Update the Webmethods Integration Server Service Alias object by id, Update the Webmethods Integration Server Service Alias object by name and version, Delete the Webmethods Integration Server Service Alias object by id, Delete the Webmethods Integration Server Service Alias object by name and version, Update the Catalog Setting object, Create a Configured Gateway Service object, Clear the Configured Gateway Service objects, Delete the Configured Gateway Service object by name or id, Create a Configured Catalog User Registry object, Delete the Configured Catalog User Registry object by name or id, Create a Configured API User Registry object, Clear the Configured API User Registry objects, Delete the Configured API User Registry object by name or id, Create a Configured TLS Client Profile object, Clear the Configured TLS Client Profile objects, Delete the Configured TLS Client Profile object by id, Delete the Configured TLS Client Profile object by name and version, Create a Configured Billing object, Clear the Configured Billing objects, Delete the Configured Billing object by name or id, Create a Configured Jwt Provider object, Clear the Configured Jwt Provider objects, Delete the Configured Jwt Provider object by name or id, Create a Configured Oauth Provider object, Clear the Configured Oauth Provider objects, Delete the Configured Oauth Provider object by name or id, Create a Configured Portal Service object, Clear the Configured Portal Service objects, Delete the Configured Portal Service object by name or id, Create a Configured Programming Package object, Clear the Configured Programming Package objects, Delete the Configured Programming Package object by id, Delete the Configured Programming Package object by name and version, List all Configured Alias objects in all collections, Clear all Configured Alias objects in all collections, Create a Configured Xslt Transformation Alias object, Clear the Configured Xslt Transformation Alias objects, Clear all Configured Xslt Transformation Alias objects in all collections, Delete the Configured Xslt Transformation Alias object by id, Delete the Configured Xslt Transformation Alias object by name and version, Create a Configured Webmethods Integration Server Service Alias object, Clear the Configured Webmethods Integration Server Service Alias objects, Clear all Configured Webmethods Integration Server Service Alias objects in all collections, Delete the Configured Webmethods Integration Server Service Alias object by id, Delete the Configured Webmethods Integration Server Service Alias object by name and version, Create a Configured Http Transport Security Alias object, Clear the Configured Http Transport Security Alias objects, Clear all Configured Http Transport Security Alias objects in all collections, Delete the Configured Http Transport Security Alias object by id, Delete the Configured Http Transport Security Alias object by name and version, Augment the Configuration Property with additional name/value pairs, Clear the Configuration Property objects, Update the Configuration Property object, Delete the Configuration Property object, Create a Global Policy object, Clear all Global Policy objects in all collections, Clear the Global Policy objects, Update the Global Policy object by id, Delete the Global Policy object by id, Update the Global Policy object by name and version, Delete the Global Policy object by name and version, Create the Global Policy Error object, Update the Global Policy Error object, Delete the Global Policy Error object, Create the Global Policy Prehook object, Update the Global Policy Prehook object, Delete the Global Policy Prehook object, Create the Global Policy Posthook object, Update the Global Policy Posthook object, Delete the Global Policy Posthook object, Create a Simple Alias object, Clear the Simple Alias objects, Update the Simple Alias object by name or id, Delete the Simple Alias object by name or id, Update the Space Setting object, Update the Consumer Organization Setting object, Delete the Consumer Organization Setting object, Create a Watsonx Settings object, Update the Watsonx Settings object by name or id, Delete the Watsonx Settings object by name or id org:view: Get the Log Spec object, List the User Registry objects, Get the User Registry object by name or id, List the User objects, Get the User object by name or id, List all Integration objects in all collections, Get the Organization Setting object, Get the Organization object by name or id, List the Associate objects, Get the Associate object by name or id, Create a User Group object, List the User Group objects, Clear the User Group objects, Get the User Group object by name or id, Update the User Group object by name or id, Delete the User Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the Member objects, Get the Member object by name or id, List the User Group Role Assignment objects, Get the User Group Role Assignment object by name or id, List all Permission objects in all collections, List the Role objects, Get the Role object by name or id, Create a Team object, List the Team objects, Clear the Team objects, Get the Team object by name or id, Update the Team object by name or id, Delete the Team object by name or id, List the Availability Zone objects, Get the Availability Zone object by name or id, List the Gateway Service objects, Get the Gateway Service object by name or id, List all Policy objects in all collections, List the Policy objects, Get the Policy object by id, Get the Policy object by name and version, List all Extension objects in all collections, List the Extension objects, Get the Extension object by id, Get the Extension object by name and version, Create the Gateway Extension object, Get the Gateway Extension object, Update the Gateway Extension object, Delete the Gateway Extension object, List the Portal Service objects, Get the Portal Service object by name or id, List the Analytics Service objects, Get the Analytics Service object by name or id, List the Opentelemetry objects, Get the Opentelemetry object by name or id, List the Oauth Provider objects, Get the Oauth Provider object by name or id, List the Jwt Provider objects, Get the Jwt Provider object by name or id, List the Mail Server objects, Get the Mail Server object by name or id, List the Billing objects, Get the Billing object by name or id, List the Itopsplatform objects, Get the Itopsplatform object by name or id, List the Job objects, Get the Job object by name or id, List all TLS Server Profile objects in all collections, List the TLS Server Profile objects, Get the TLS Server Profile object by id, Get the TLS Server Profile object by name and version, List all TLS Client Profile objects in all collections, List the TLS Client Profile objects, Get the TLS Client Profile object by id, Get the TLS Client Profile object by name and version, List the Keystore objects, Get the Keystore object by name or id, List the Truststore objects, Get the Truststore object by name or id, List the Entry objects, Get the Entry object by name or id, List the Jwk Set objects, Get the Jwk Set object by name or id, List the Programming Package objects, List all Programming Package objects in all collections, Get the Programming Package object by id, Get the Programming Package object by name and version, List the Xslt Transformation Alias objects, List all Xslt Transformation Alias objects in all collections, Get the Xslt Transformation Alias object by id, Get the Xslt Transformation Alias object by name and version, List the Http Transport Security Alias objects, List all Http Transport Security Alias objects in all collections, Get the Http Transport Security Alias object by id, Get the Http Transport Security Alias object by name and version, List the Webmethods Integration Server Service Alias objects, List all Webmethods Integration Server Service Alias objects in all collections, Get the Webmethods Integration Server Service Alias object by id, Get the Webmethods Integration Server Service Alias object by name and version, Get the Catalog Setting object, List the Configured Gateway Service objects, Get the Configured Gateway Service object by name or id, List the Configured Catalog User Registry objects, Get the Configured Catalog User Registry object by name or id, List the Configured API User Registry objects, Get the Configured API User Registry object by name or id, List all Configured TLS Client Profile objects in all collections, Clear all Configured TLS Client Profile objects in all collections, List the Configured TLS Client Profile objects, Get the Configured TLS Client Profile object by id, Get the Configured TLS Client Profile object by name and version, List the Configured Billing objects, Get the Configured Billing object by name or id, List the Configured Jwt Provider objects, Get the Configured Jwt Provider object by name or id, List the Configured Oauth Provider objects, Get the Configured Oauth Provider object by name or id, List the Configured Portal Service objects, Get the Configured Portal Service object by name or id, List the Configured Programming Package objects, List all Configured Programming Package objects in all collections, Clear all Configured Programming Package objects in all collections, Get the Configured Programming Package object by id, Get the Configured Programming Package object by name and version, List the Configured Xslt Transformation Alias objects, List all Configured Xslt Transformation Alias objects in all collections, Get the Configured Xslt Transformation Alias object by id, Get the Configured Xslt Transformation Alias object by name and version, List the Configured Webmethods Integration Server Service Alias objects, List all Configured Webmethods Integration Server Service Alias objects in all collections, Get the Configured Webmethods Integration Server Service Alias object by id, Get the Configured Webmethods Integration Server Service Alias object by name and version, List the Configured Http Transport Security Alias objects, List all Configured Http Transport Security Alias objects in all collections, Get the Configured Http Transport Security Alias object by id, Get the Configured Http Transport Security Alias object by name and version, List the Configuration Property objects, Get the Configuration Property object, List all Global Policy objects in all collections, List the Global Policy objects, Get the Global Policy object by id, Get the Global Policy object by name and version, Get the Global Policy Error object, Get the Global Policy Prehook object, Get the Global Policy Posthook object, List the Simple Alias objects, Get the Simple Alias object by name or id, Get the Space Setting object, Get the Consumer Organization Setting object, List the Primary Event objects, Get the Primary Event object by name or id, List the Subscriber Event objects, Get the Subscriber Event object by name or id, List the Task Queue objects, Get the Task Queue object by name or id, List the Watsonx Settings objects, Get the Watsonx Settings object by name or id, List the Resource Service Status objects product-drafts:edit: Create a Draft Product object, Clear all Draft Product objects in all collections, Clear the Draft Product objects, Update the Draft Product object by id, Delete the Draft Product object by id, Update the Draft Product object by name and version, Delete the Draft Product object by name and version product-drafts:view: List all Draft Product objects in all collections, List the Draft Product objects, Get the Draft Product object by id, Get the Draft Product object by name and version product:manage: Clear all Product objects in all collections, Clear the Product objects, Update the Product object by id, Delete the Product object by id, Update the Product object by name and version, Delete the Product object by name and version, Update the API object by id, Update the API object by name and version product:view: List all Product objects in all collections, List the Product objects, Get the Product object by id, Get the Product object by name and version, List all API objects in all collections, List the API objects, Get the API object by id, Get the API object by name and version, Get the Plan object by id, Get the Plan object by name and version, List the Plan objects, List all Plan objects in all collections, Get the Quota object by id, Get the Quota object by name and version, List the Quota objects, List all Quota objects in all collections project:manage: Create a Project object, Clear the Project objects, Update the Project object by name or id, Delete the Project object by name or id, Clear the Project File objects, Clear all Project File objects in all collections, Update the Project File object by id, Update the Project File object by name and version, Delete the Project File object by id, Delete the Project File object by name and version project:view: List the Project objects, Get the Project object by name or id, List the Project File objects, List all Project File objects in all collections, Get the Project File object by id, Get the Project File object by name and version provider-org:manage: Create an Organization Invitation object, Clear the Organization Invitation objects, Update the Organization Invitation object by name or id, Delete the Organization Invitation object by name or id, Create a Group object, Clear the Group objects, Update the Group object by name or id, Delete the Group object by name or id provider-org:view: List the Organization Invitation objects, Get the Organization Invitation object by name or id, List the Group objects, Get the Group object by name or id webhook:manage: Update the Webhook object by name or id webhook:view: List the Webhook objects, Get the Webhook object by name or id authorizationCode: authorizationUrl: /oauth2/authorize tokenUrl: /token refreshUrl: /token scopes: api-drafts:edit: Clear the Draft objects, Create a Draft API object, Clear all Draft API objects in all collections, Clear the Draft API objects, Update the Draft API object by id, Delete the Draft API object by id, Update the Draft API object by name and version, Delete the Draft API object by name and version api-drafts:view: List the Draft objects, List all Draft API objects in all collections, List the Draft API objects, Get the Draft API object by id, Get the Draft API object by name and version app:manage:all: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Strategy object, Delete the Strategy object by name or id, Clear the Strategy objects, Update the Strategy object by name or id, Create a Application Credential object, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id app:view:all: List the Application objects, Get the Application object by name or id, List the Strategy objects, Get the Strategy object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id approval:view: List the Task objects, Get the Task object by name or id, Update the Task object by name or id, List the Task History objects, Get the Task History object by name or id child:create: Create a Catalog object, Create a Space object child:manage: Clear the Catalog objects, Update the Catalog object by name or id, Delete the Catalog object by name or id, Clear the Space objects, Update the Space object by name or id, Delete the Space object by name or id child:view: List the Catalog objects, Get the Catalog object by name or id, List the Space objects, Get the Space object by name or id cloud:manage: Update the Cloud Setting object, Update the User Registry Setting object, Update the Notification Style object, Create a Registration object, Clear the Registration objects, Update the Registration object by name or id, Delete the Registration object by name or id, Update the Webhook object by name or id cloud:view: Get the Cloud Setting object, Get the User Registry Setting object, Get the Notification Style object, List all Notification Template objects in all collections, List all Role Default objects in all collections, List the Registration objects, Get the Registration object by name or id, List the Webhook objects, Get the Webhook object by name or id consumer-org:manage: Clear the Activation objects, Delete the Activation object by name or id, Create a Consumer Organization object, Clear the Consumer Organization objects, Update the Consumer Organization object by name or id, Delete the Consumer Organization object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id consumer-org:view: List the Activation objects, Get the Activation object by name or id, List the Consumer Organization objects, Get the Consumer Organization object by name or id, List the Payment Method objects, Get the Payment Method object by name or id my:manage: Create a API Key object, Delete the API Key object by name or id, Update the Me object, Delete the Me object my:view: List the API Key objects, Get the API Key object by name or id, Get the Me object, List the My Permission objects, List the My Task objects, List the Originated Task objects, List the My Organization objects, List the My Catalog objects, List the My Space objects, List the My User Group objects, List the My Team objects org:manage: Update the Log Spec object, Create a User Registry object, Clear the User Registry objects, Update the User Registry object by name or id, Delete the User Registry object by name or id, Create a User object, Clear the User objects, Update the User object by name or id, Delete the User object by name or id, Update the Organization Setting object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Update the Member Invitation object by name or id, Delete the Member Invitation object by name or id, Create a Member object, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a User Group Role Assignment object, Clear the User Group Role Assignment objects, Update the User Group Role Assignment object by name or id, Delete the User Group Role Assignment object by name or id, Create a Role object, Clear the Role objects, Update the Role object by name or id, Delete the Role object by name or id, Create a Availability Zone object, Clear the Availability Zone objects, Update the Availability Zone object by name or id, Delete the Availability Zone object by name or id, Create a Gateway Service object, Clear the Gateway Service objects, Update the Gateway Service object by name or id, Delete the Gateway Service object by name or id, Create a Portal Service object, Clear the Portal Service objects, Update the Portal Service object by name or id, Delete the Portal Service object by name or id, Create a Analytics Service object, Clear the Analytics Service objects, Update the Analytics Service object by name or id, Delete the Analytics Service object by name or id, Create a Opentelemetry object, Clear the Opentelemetry objects, Update the Opentelemetry object by name or id, Delete the Opentelemetry object by name or id, Create a Oauth Provider object, Clear the Oauth Provider objects, Update the Oauth Provider object by name or id, Delete the Oauth Provider object by name or id, Create a Jwt Provider object, Clear the Jwt Provider objects, Update the Jwt Provider object by name or id, Delete the Jwt Provider object by name or id, Create a Mail Server object, Clear the Mail Server objects, Update the Mail Server object by name or id, Delete the Mail Server object by name or id, Create a Billing object, Clear the Billing objects, Update the Billing object by name or id, Delete the Billing object by name or id, Create a Itopsplatform object, Clear the Itopsplatform objects, Update the Itopsplatform object by name or id, Delete the Itopsplatform object by name or id, Clear the Job objects, Delete the Job object by name or id, Create a TLS Server Profile object, Clear all TLS Server Profile objects in all collections, Clear the TLS Server Profile objects, Update the TLS Server Profile object by id, Delete the TLS Server Profile object by id, Update the TLS Server Profile object by name and version, Delete the TLS Server Profile object by name and version, Create a TLS Client Profile object, Clear all TLS Client Profile objects in all collections, Clear the TLS Client Profile objects, Update the TLS Client Profile object by id, Delete the TLS Client Profile object by id, Update the TLS Client Profile object by name and version, Delete the TLS Client Profile object by name and version, Create a Keystore object, Clear the Keystore objects, Update the Keystore object by name or id, Delete the Keystore object by name or id, Create a Truststore object, Clear the Truststore objects, Update the Truststore object by name or id, Delete the Truststore object by name or id, Create a Entry object, Clear the Entry objects, Update the Entry object by name or id, Delete the Entry object by name or id, Create a Jwk Set object, Clear the Jwk Set objects, Delete the Jwk Set object by name or id, Create a Programming Package object, Clear the Programming Package objects, Clear all Programming Package objects in all collections, Update the Programming Package object by id, Update the Programming Package object by name and version, Delete the Programming Package object by id, Delete the Programming Package object by name and version, List all Alias objects in all collections, Clear all Alias objects in all collections, Create a Xslt Transformation Alias object, Clear the Xslt Transformation Alias objects, Clear all Xslt Transformation Alias objects in all collections, Update the Xslt Transformation Alias object by id, Update the Xslt Transformation Alias object by name and version, Delete the Xslt Transformation Alias object by id, Delete the Xslt Transformation Alias object by name and version, Create a Http Transport Security Alias object, Clear the Http Transport Security Alias objects, Clear all Http Transport Security Alias objects in all collections, Update the Http Transport Security Alias object by id, Update the Http Transport Security Alias object by name and version, Delete the Http Transport Security Alias object by id, Delete the Http Transport Security Alias object by name and version, Create a Webmethods Integration Server Service Alias object, Clear the Webmethods Integration Server Service Alias objects, Clear all Webmethods Integration Server Service Alias objects in all collections, Update the Webmethods Integration Server Service Alias object by id, Update the Webmethods Integration Server Service Alias object by name and version, Delete the Webmethods Integration Server Service Alias object by id, Delete the Webmethods Integration Server Service Alias object by name and version, Update the Catalog Setting object, Create a Configured Gateway Service object, Clear the Configured Gateway Service objects, Delete the Configured Gateway Service object by name or id, Create a Configured Catalog User Registry object, Delete the Configured Catalog User Registry object by name or id, Create a Configured API User Registry object, Clear the Configured API User Registry objects, Delete the Configured API User Registry object by name or id, Create a Configured TLS Client Profile object, Clear the Configured TLS Client Profile objects, Delete the Configured TLS Client Profile object by id, Delete the Configured TLS Client Profile object by name and version, Create a Configured Billing object, Clear the Configured Billing objects, Delete the Configured Billing object by name or id, Create a Configured Jwt Provider object, Clear the Configured Jwt Provider objects, Delete the Configured Jwt Provider object by name or id, Create a Configured Oauth Provider object, Clear the Configured Oauth Provider objects, Delete the Configured Oauth Provider object by name or id, Create a Configured Portal Service object, Clear the Configured Portal Service objects, Delete the Configured Portal Service object by name or id, Create a Configured Programming Package object, Clear the Configured Programming Package objects, Delete the Configured Programming Package object by id, Delete the Configured Programming Package object by name and version, List all Configured Alias objects in all collections, Clear all Configured Alias objects in all collections, Create a Configured Xslt Transformation Alias object, Clear the Configured Xslt Transformation Alias objects, Clear all Configured Xslt Transformation Alias objects in all collections, Delete the Configured Xslt Transformation Alias object by id, Delete the Configured Xslt Transformation Alias object by name and version, Create a Configured Webmethods Integration Server Service Alias object, Clear the Configured Webmethods Integration Server Service Alias objects, Clear all Configured Webmethods Integration Server Service Alias objects in all collections, Delete the Configured Webmethods Integration Server Service Alias object by id, Delete the Configured Webmethods Integration Server Service Alias object by name and version, Create a Configured Http Transport Security Alias object, Clear the Configured Http Transport Security Alias objects, Clear all Configured Http Transport Security Alias objects in all collections, Delete the Configured Http Transport Security Alias object by id, Delete the Configured Http Transport Security Alias object by name and version, Augment the Configuration Property with additional name/value pairs, Clear the Configuration Property objects, Update the Configuration Property object, Delete the Configuration Property object, Create a Global Policy object, Clear all Global Policy objects in all collections, Clear the Global Policy objects, Update the Global Policy object by id, Delete the Global Policy object by id, Update the Global Policy object by name and version, Delete the Global Policy object by name and version, Create the Global Policy Error object, Update the Global Policy Error object, Delete the Global Policy Error object, Create the Global Policy Prehook object, Update the Global Policy Prehook object, Delete the Global Policy Prehook object, Create the Global Policy Posthook object, Update the Global Policy Posthook object, Delete the Global Policy Posthook object, Create a Simple Alias object, Clear the Simple Alias objects, Update the Simple Alias object by name or id, Delete the Simple Alias object by name or id, Update the Space Setting object, Update the Consumer Organization Setting object, Delete the Consumer Organization Setting object, Create a Watsonx Settings object, Update the Watsonx Settings object by name or id, Delete the Watsonx Settings object by name or id org:view: Get the Log Spec object, List the User Registry objects, Get the User Registry object by name or id, List the User objects, Get the User object by name or id, List all Integration objects in all collections, Get the Organization Setting object, Get the Organization object by name or id, List the Associate objects, Get the Associate object by name or id, Create a User Group object, List the User Group objects, Clear the User Group objects, Get the User Group object by name or id, Update the User Group object by name or id, Delete the User Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the Member objects, Get the Member object by name or id, List the User Group Role Assignment objects, Get the User Group Role Assignment object by name or id, List all Permission objects in all collections, List the Role objects, Get the Role object by name or id, Create a Team object, List the Team objects, Clear the Team objects, Get the Team object by name or id, Update the Team object by name or id, Delete the Team object by name or id, List the Availability Zone objects, Get the Availability Zone object by name or id, List the Gateway Service objects, Get the Gateway Service object by name or id, List all Policy objects in all collections, List the Policy objects, Get the Policy object by id, Get the Policy object by name and version, List all Extension objects in all collections, List the Extension objects, Get the Extension object by id, Get the Extension object by name and version, Create the Gateway Extension object, Get the Gateway Extension object, Update the Gateway Extension object, Delete the Gateway Extension object, List the Portal Service objects, Get the Portal Service object by name or id, List the Analytics Service objects, Get the Analytics Service object by name or id, List the Opentelemetry objects, Get the Opentelemetry object by name or id, List the Oauth Provider objects, Get the Oauth Provider object by name or id, List the Jwt Provider objects, Get the Jwt Provider object by name or id, List the Mail Server objects, Get the Mail Server object by name or id, List the Billing objects, Get the Billing object by name or id, List the Itopsplatform objects, Get the Itopsplatform object by name or id, List the Job objects, Get the Job object by name or id, List all TLS Server Profile objects in all collections, List the TLS Server Profile objects, Get the TLS Server Profile object by id, Get the TLS Server Profile object by name and version, List all TLS Client Profile objects in all collections, List the TLS Client Profile objects, Get the TLS Client Profile object by id, Get the TLS Client Profile object by name and version, List the Keystore objects, Get the Keystore object by name or id, List the Truststore objects, Get the Truststore object by name or id, List the Entry objects, Get the Entry object by name or id, List the Jwk Set objects, Get the Jwk Set object by name or id, List the Programming Package objects, List all Programming Package objects in all collections, Get the Programming Package object by id, Get the Programming Package object by name and version, List the Xslt Transformation Alias objects, List all Xslt Transformation Alias objects in all collections, Get the Xslt Transformation Alias object by id, Get the Xslt Transformation Alias object by name and version, List the Http Transport Security Alias objects, List all Http Transport Security Alias objects in all collections, Get the Http Transport Security Alias object by id, Get the Http Transport Security Alias object by name and version, List the Webmethods Integration Server Service Alias objects, List all Webmethods Integration Server Service Alias objects in all collections, Get the Webmethods Integration Server Service Alias object by id, Get the Webmethods Integration Server Service Alias object by name and version, Get the Catalog Setting object, List the Configured Gateway Service objects, Get the Configured Gateway Service object by name or id, List the Configured Catalog User Registry objects, Get the Configured Catalog User Registry object by name or id, List the Configured API User Registry objects, Get the Configured API User Registry object by name or id, List all Configured TLS Client Profile objects in all collections, Clear all Configured TLS Client Profile objects in all collections, List the Configured TLS Client Profile objects, Get the Configured TLS Client Profile object by id, Get the Configured TLS Client Profile object by name and version, List the Configured Billing objects, Get the Configured Billing object by name or id, List the Configured Jwt Provider objects, Get the Configured Jwt Provider object by name or id, List the Configured Oauth Provider objects, Get the Configured Oauth Provider object by name or id, List the Configured Portal Service objects, Get the Configured Portal Service object by name or id, List the Configured Programming Package objects, List all Configured Programming Package objects in all collections, Clear all Configured Programming Package objects in all collections, Get the Configured Programming Package object by id, Get the Configured Programming Package object by name and version, List the Configured Xslt Transformation Alias objects, List all Configured Xslt Transformation Alias objects in all collections, Get the Configured Xslt Transformation Alias object by id, Get the Configured Xslt Transformation Alias object by name and version, List the Configured Webmethods Integration Server Service Alias objects, List all Configured Webmethods Integration Server Service Alias objects in all collections, Get the Configured Webmethods Integration Server Service Alias object by id, Get the Configured Webmethods Integration Server Service Alias object by name and version, List the Configured Http Transport Security Alias objects, List all Configured Http Transport Security Alias objects in all collections, Get the Configured Http Transport Security Alias object by id, Get the Configured Http Transport Security Alias object by name and version, List the Configuration Property objects, Get the Configuration Property object, List all Global Policy objects in all collections, List the Global Policy objects, Get the Global Policy object by id, Get the Global Policy object by name and version, Get the Global Policy Error object, Get the Global Policy Prehook object, Get the Global Policy Posthook object, List the Simple Alias objects, Get the Simple Alias object by name or id, Get the Space Setting object, Get the Consumer Organization Setting object, List the Primary Event objects, Get the Primary Event object by name or id, List the Subscriber Event objects, Get the Subscriber Event object by name or id, List the Task Queue objects, Get the Task Queue object by name or id, List the Watsonx Settings objects, Get the Watsonx Settings object by name or id, List the Resource Service Status objects product-drafts:edit: Create a Draft Product object, Clear all Draft Product objects in all collections, Clear the Draft Product objects, Update the Draft Product object by id, Delete the Draft Product object by id, Update the Draft Product object by name and version, Delete the Draft Product object by name and version product-drafts:view: List all Draft Product objects in all collections, List the Draft Product objects, Get the Draft Product object by id, Get the Draft Product object by name and version product:manage: Clear all Product objects in all collections, Clear the Product objects, Update the Product object by id, Delete the Product object by id, Update the Product object by name and version, Delete the Product object by name and version, Update the API object by id, Update the API object by name and version product:view: List all Product objects in all collections, List the Product objects, Get the Product object by id, Get the Product object by name and version, List all API objects in all collections, List the API objects, Get the API object by id, Get the API object by name and version, Get the Plan object by id, Get the Plan object by name and version, List the Plan objects, List all Plan objects in all collections, Get the Quota object by id, Get the Quota object by name and version, List the Quota objects, List all Quota objects in all collections project:manage: Create a Project object, Clear the Project objects, Update the Project object by name or id, Delete the Project object by name or id, Clear the Project File objects, Clear all Project File objects in all collections, Update the Project File object by id, Update the Project File object by name and version, Delete the Project File object by id, Delete the Project File object by name and version project:view: List the Project objects, Get the Project object by name or id, List the Project File objects, List all Project File objects in all collections, Get the Project File object by id, Get the Project File object by name and version provider-org:manage: Create an Organization Invitation object, Clear the Organization Invitation objects, Update the Organization Invitation object by name or id, Delete the Organization Invitation object by name or id, Create a Group object, Clear the Group objects, Update the Group object by name or id, Delete the Group object by name or id provider-org:view: List the Organization Invitation objects, Get the Organization Invitation object by name or id, List the Group objects, Get the Group object by name or id webhook:manage: Update the Webhook object by name or id webhook:view: List the Webhook objects, Get the Webhook object by name or id x-refined-from: - ibm-api-connect-cloud-management-api-openapi.yml - ibm-api-connect-consumer-api-openapi.yml - ibm-api-connect-management-api-openapi.yml x-ibm-configuration: testable: false