openapi: 3.2.0
info:
  title: Ibm Api Connect Cloud Settings 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 Cloud Settings across 2 of this provider''s published API definitions: ibm-api-connect-cloud-management-api-openapi.yml, ibm-api-connect-discovery-api-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Cloud Settings
paths:
  /cloud/settings:
    description: Cloud Setting object operations
    get:
      summary: Get the Cloud Setting object
      operationId: cloud_setting_singletonGet
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudSetting'
            application/yaml:
              schema:
                $ref: '#/components/schemas/CloudSetting'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    put:
      summary: Update the Cloud Setting object
      description: 'Update the Cloud Setting object


        Fields not allowed to be null:

        - email_sender

        - tls_client_profile_default_url


        Fields not allowed:

        - service_type

        - cloud_id

        - ibm_cloud


        Fields allowed but ignored:

        - name

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: cloud_setting_singletonUpdate
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudSetting'
            examples:
              CloudSetting:
                summary: Example of fields which can be updated on a cloud settings object.
                value:
                  mail_server_url: https://acme-apim.example.com/api/orgs/mail-servers
                  invitation_ttl: 172800
                  reset_password_ttl: 172800
                  provision_sandbox_catalog: true
                  restrict_member_manage_permission: false
                  access_token_expires_in: 28800
                  refresh_token_enabled: false
                  refresh_expires_in: 57600
                  api_key_enabled: true
                  api_key_expires_in: 300
                  api_key_multiple_uses: false
                  sso_settings:
                    enabled: false
                    registration_urls: []
                    user_registry_urls: []
                  audit_setting:
                    mode: non_block
                    enabled: false
                    audit_reads:
                      enabled: false
                      response_data_to_http_endpoints:
                        enabled: false
                        list_results_limit: 0
                  gateway_service_default_urls:
                  - https://acme-apim.example.com/api/orgs/availability-zones/gateway-service1
                  - https://acme-apim.example.com/api/orgs/availability-zones/gateway-service2
                  email_sender:
                    name: ACME Administrator
                    address: acme-mail@example.com
                  tls_client_profile_default_url: https://acme-apim.example.com/api/orgs/tls-client-profiles
                  access_token_keystore_urls:
                  - https://acme-apim.example.com/api/orgs/keystores
                  id_token_keystore_urls:
                  - https://acme-apim.example.com/api/orgs/keystores
                  temporary_token_keystore_urls:
                  - https://acme-apim.example.com/api/orgs/keystores
                  self_signed_token_keystore_urls:
                  - https://acme-apim.example.com/api/orgs/keystores
                  temporary_token_format: b64
                  sync_roles_setting:
                    enabled: false
          application/yaml:
            schema:
              $ref: '#/components/schemas/CloudSetting'
            examples:
              CloudSetting:
                summary: Example of fields which can be updated on a cloud settings object.
                value:
                  mail_server_url: https://acme-apim.example.com/api/orgs/mail-servers
                  invitation_ttl: 172800
                  reset_password_ttl: 172800
                  provision_sandbox_catalog: true
                  restrict_member_manage_permission: false
                  access_token_expires_in: 28800
                  refresh_token_enabled: false
                  refresh_expires_in: 57600
                  api_key_enabled: true
                  api_key_expires_in: 300
                  api_key_multiple_uses: false
                  sso_settings:
                    enabled: false
                    registration_urls: []
                    user_registry_urls: []
                  audit_setting:
                    mode: non_block
                    enabled: false
                    audit_reads:
                      enabled: false
                      response_data_to_http_endpoints:
                        enabled: false
                        list_results_limit: 0
                  gateway_service_default_urls:
                  - https://acme-apim.example.com/api/orgs/availability-zones/gateway-service1
                  - https://acme-apim.example.com/api/orgs/availability-zones/gateway-service2
                  email_sender:
                    name: ACME Administrator
                    address: acme-mail@example.com
                  tls_client_profile_default_url: https://acme-apim.example.com/api/orgs/tls-client-profiles
                  access_token_keystore_urls:
                  - https://acme-apim.example.com/api/orgs/keystores
                  id_token_keystore_urls:
                  - https://acme-apim.example.com/api/orgs/keystores
                  temporary_token_keystore_urls:
                  - https://acme-apim.example.com/api/orgs/keystores
                  self_signed_token_keystore_urls:
                  - https://acme-apim.example.com/api/orgs/keystores
                  temporary_token_format: b64
                  sync_roles_setting:
                    enabled: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudSetting'
            application/yaml:
              schema:
                $ref: '#/components/schemas/CloudSetting'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/audit-endpoint/test-connection:
    post:
      summary: Test an audit endpoint connection
      operationId: cloud_setting_auditEndpointTestConnection
      security:
      - oauth:
        - org:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuditEndpointTestConnection'
          application/yaml:
            schema:
              $ref: '#/components/schemas/AuditEndpointTestConnection'
      responses:
        '204':
          description: Success
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/apicp-endpoint/test-connection:
    post:
      summary: Test an API Control Plane endpoint connection
      operationId: cloud_setting_apiControlPlaneEndpointTestConnection
      security:
      - oauth:
        - org:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiControlPlaneEndpointTestConnection'
          application/yaml:
            schema:
              $ref: '#/components/schemas/ApiControlPlaneEndpointTestConnection'
            examples:
              ApiControlPlaneEndpointTestConnection:
                summary: Example for control plane endpoint test connection.
                value:
                  endpoint:
                    endpoint: https://api.fam.acme-apim.example.com
                    tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1
                  credentials:
                    password: '******'
                    username: administrator
                  ui_endpoint:
                    endpoint: https://fam.acme-apim.example.com
      responses:
        '204':
          description: Success
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/info:
    get:
      summary: Return public information about the cloud deployment
      operationId: cloud_setting_publicInfo
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudPublicInfo'
            application/yaml:
              schema:
                $ref: '#/components/schemas/CloudPublicInfo'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/about:
    get:
      summary: Return information about the cloud
      description: Return public information about the cloud. You MUST supply the --format option when using this command from the API Connect toolkit.
      operationId: cloud_setting_about
      security:
      - oauth:
        - org:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudAbout'
            application/yaml:
              schema:
                $ref: '#/components/schemas/CloudAbout'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/topology:
    get:
      summary: Return the topology of the cloud for governance
      description: Return the topology of the cloud for governance. You MUST supply the --format option when using this command from the API Connect toolkit.
      operationId: cloud_setting_topology
      security:
      - oauth:
        - org:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudTopology'
            application/yaml:
              schema:
                $ref: '#/components/schemas/CloudTopology'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/mail-server-configured:
    get:
      summary: Return true or false based on if mail server is configured or not
      description: Return true or false based on if mail server is configured or not. You MUST supply the --format option when using this command from the API Connect toolkit.
      operationId: cloud_setting_mailServerConfigured
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailServerConfigured'
            application/yaml:
              schema:
                $ref: '#/components/schemas/MailServerConfigured'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/toolkit-credentials:
    get:
      summary: List credential for toolkit, consumer toolkit, governance, and discovery toolkit
      operationId: cloud_setting_toolkitCredentialsList
      security:
      - oauth:
        - org:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolkitCredentialsResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ToolkitCredentialsResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/designer-credentials:
    get:
      summary: List credential for designer
      operationId: cloud_setting_designerCredentialsList
      security:
      - oauth:
        - org:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DesignerCredentialsResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/DesignerCredentialsResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/transition-helper-credentials:
    get:
      summary: List credential for transition-helper
      operationId: cloud_setting_transitionHelperCredentialsList
      security:
      - oauth:
        - org:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransitionHelperCredentialsResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/TransitionHelperCredentialsResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/oauth2/certs:
    get:
      summary: Support JWKS_URI endpoint, conform to OIDC specification
      description: Return JWKS that is used to issue token. You MUST supply the --format option when using this command from the API Connect toolkit.
      operationId: cloud_setting_oauth2Certs
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Oauth2CertsResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/Oauth2CertsResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/user-registries:
    description: User Registry Setting object operations
    get:
      summary: Get the User Registry Setting object
      operationId: user_registry_setting_singletonGet
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRegistrySetting'
            application/yaml:
              schema:
                $ref: '#/components/schemas/UserRegistrySetting'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    put:
      summary: Update the User Registry Setting object
      description: 'Update the User Registry Setting object


        Fields allowed but ignored:

        - name

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: user_registry_setting_singletonUpdate
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRegistrySetting'
            examples:
              UserRegistrySetting:
                summary: Example of User Registry Setting update.
                value:
                  title: User Registry Setting Update
                  summary: An example User Registry Setting Update
                  admin_user_registry_urls:
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-1
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-2
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-3
                  admin_user_registry_default_url: https://acme-apim.example.com/api/user-registries/org1/user-registry-2
                  provider_user_registry_urls:
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-4
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-5
                  provider_user_registry_default_url: https://acme-apim.example.com/api/user-registries/org1/user-registry-5
          application/yaml:
            schema:
              $ref: '#/components/schemas/UserRegistrySetting'
            examples:
              UserRegistrySetting:
                summary: Example of User Registry Setting update.
                value:
                  title: User Registry Setting Update
                  summary: An example User Registry Setting Update
                  admin_user_registry_urls:
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-1
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-2
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-3
                  admin_user_registry_default_url: https://acme-apim.example.com/api/user-registries/org1/user-registry-2
                  provider_user_registry_urls:
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-4
                  - https://acme-apim.example.com/api/user-registries/org1/user-registry-5
                  provider_user_registry_default_url: https://acme-apim.example.com/api/user-registries/org1/user-registry-5
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRegistrySetting'
            application/yaml:
              schema:
                $ref: '#/components/schemas/UserRegistrySetting'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-style:
    description: Notification Style object operations
    get:
      summary: Get the Notification Style object
      operationId: notification_style_singletonGetCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationStyle'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationStyle'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    put:
      summary: Update the Notification Style object
      description: 'Update the Notification Style object


        Fields allowed but ignored:

        - name

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url

        - org_url

        - catalog_url

        - space_url

        - consumer_org_url'
      operationId: notification_style_singletonUpdateCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationStyle'
            examples:
              NotificationStyle:
                summary: Example of notification style update at org scope.
                value:
                  title: Acme notification style
                  summary: An example notification style
                  allowed_html_tags:
                    a:
                    - class
                    - href
                    - hreflang
                    - style
                    p:
                    - class
                    - style
                    br:
                    - class
                    - style
                    h1:
                    - class
                    - id
                    - style
                    img:
                    - class
                    - src
                    - alt
                    - width
                    - height
                    - style
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationStyle'
            examples:
              NotificationStyle:
                summary: Example of notification style update at org scope.
                value:
                  title: Acme notification style
                  summary: An example notification style
                  allowed_html_tags:
                    a:
                    - class
                    - href
                    - hreflang
                    - style
                    p:
                    - class
                    - style
                    br:
                    - class
                    - style
                    h1:
                    - class
                    - id
                    - style
                    img:
                    - class
                    - src
                    - alt
                    - width
                    - height
                    - style
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationStyle'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationStyle'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates:
    description: Notification Template operations across all collections
    get:
      summary: List all Notification Template objects in all collections
      operationId: notification_template_listAllCloudScope
      security:
      - oauth:
        - cloud: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/NotificationTemplateList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplateList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/cloud:
    description: The collection of Notification Template operations
    get:
      summary: List the Notification Template objects
      operationId: notification_template_listCloudSubcollectionCloudScope
      security:
      - oauth:
        - cloud: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/NotificationTemplateList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplateList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/cloud/{notification-template}:
    description: Notification Template object operations
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: Get the Notification Template object by name or id
      operationId: notification_template_getCloudSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification Template object by name or id
      description: 'Update the Notification Template object by name or id


        Fields not allowed:

        - name

        - notification_template_type


        Fields allowed but ignored:

        - id

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: notification_template_updateCloudSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and cloud subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello,


                    You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.


                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and cloud subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/cloud/{notification-template}/notification-languages:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: List the Notification language objects
      operationId: notification_language_listCloudSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/cloud/{notification-template}/notification-languages/{notification-language}:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    - $ref: '#/components/parameters/notification-language'
    get:
      summary: Get the Notification template language by name or id
      operationId: notification_language_getCloudSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification template language object
      operationId: notification_language_updateCloudSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
            examples:
              NotificationLanguage:
                summary: Example of notification language update at cloud scope and cloud subcollection.
                value:
                  title: Example notification language update
                  notification_template_name: invitation
                  notification_template_type: consumer
                  subject: Invitation to create an API consumer organization in the Acme catalog
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
                  - html
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/admin:
    description: The collection of Notification Template operations
    get:
      summary: List the Notification Template objects
      operationId: notification_template_listAdminSubcollectionCloudScope
      security:
      - oauth:
        - cloud: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/NotificationTemplateList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplateList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/admin/{notification-template}:
    description: Notification Template object operations
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: Get the Notification Template object by name or id
      operationId: notification_template_getAdminSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification Template object by name or id
      description: 'Update the Notification Template object by name or id


        Fields not allowed:

        - name

        - notification_template_type


        Fields allowed but ignored:

        - id

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: notification_template_updateAdminSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and admin subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello,


                    You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.


                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and admin subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/admin/{notification-template}/notification-languages:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: List the Notification language objects
      operationId: notification_language_listAdminSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/admin/{notification-template}/notification-languages/{notification-language}:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    - $ref: '#/components/parameters/notification-language'
    get:
      summary: Get the Notification template language by name or id
      operationId: notification_language_getAdminSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification template language object
      operationId: notification_language_updateAdminSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
            examples:
              NotificationLanguage:
                summary: Example of notification language update at cloud scope and admin subcollection.
                value:
                  title: Example notification language update
                  notification_template_name: member-invitation
                  notification_template_type: admin
                  subject: Invitation to an admin organization in IBM API Connect
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
                  - html
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/provider:
    description: The collection of Notification Template operations
    get:
      summary: List the Notification Template objects
      operationId: notification_template_listProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud: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/NotificationTemplateList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplateList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/provider/{notification-template}:
    description: Notification Template object operations
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: Get the Notification Template object by name or id
      operationId: notification_template_getProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification Template object by name or id
      description: 'Update the Notification Template object by name or id


        Fields not allowed:

        - name

        - notification_template_type


        Fields allowed but ignored:

        - id

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: notification_template_updateProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and provider subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello,


                    You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.


                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and provider subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/provider/{notification-template}/notification-languages:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: List the Notification language objects
      operationId: notification_language_listProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/provider/{notification-template}/notification-languages/{notification-language}:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    - $ref: '#/components/parameters/notification-language'
    get:
      summary: Get the Notification template language by name or id
      operationId: notification_language_getProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification template language object
      operationId: notification_language_updateProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
            examples:
              NotificationLanguage:
                summary: Example of notification language update at cloud scope and provider subcollection.
                value:
                  title: Example notification language update
                  notification_template_name: invitation
                  notification_template_type: provider
                  subject: Invitation to create an API provider organization in IBM API Connect
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
                  - html
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/catalog:
    description: The collection of Notification Template operations
    get:
      summary: List the Notification Template objects
      operationId: notification_template_listCatalogSubcollectionCloudScope
      security:
      - oauth:
        - cloud: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/NotificationTemplateList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplateList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/catalog/{notification-template}:
    description: Notification Template object operations
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: Get the Notification Template object by name or id
      operationId: notification_template_getCatalogSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification Template object by name or id
      description: 'Update the Notification Template object by name or id


        Fields not allowed:

        - name

        - notification_template_type


        Fields allowed but ignored:

        - id

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: notification_template_updateCatalogSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and catalog subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello,


                    You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.


                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and catalog subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/catalog/{notification-template}/notification-languages:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: List the Notification language objects
      operationId: notification_language_listCatalogSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/catalog/{notification-template}/notification-languages/{notification-language}:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    - $ref: '#/components/parameters/notification-language'
    get:
      summary: Get the Notification template language by name or id
      operationId: notification_language_getCatalogSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification template language object
      operationId: notification_language_updateCatalogSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
            examples:
              NotificationLanguage:
                summary: Example of notification language update at cloud scope and catalog subcollection.
                value:
                  title: Example notification language update
                  notification_template_name: invitation
                  notification_template_type: catalog
                  subject: Invitation to join Acme
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
                  - html
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/space:
    description: The collection of Notification Template operations
    get:
      summary: List the Notification Template objects
      operationId: notification_template_listSpaceSubcollectionCloudScope
      security:
      - oauth:
        - cloud: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/NotificationTemplateList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplateList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/space/{notification-template}:
    description: Notification Template object operations
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: Get the Notification Template object by name or id
      operationId: notification_template_getSpaceSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification Template object by name or id
      description: 'Update the Notification Template object by name or id


        Fields not allowed:

        - name

        - notification_template_type


        Fields allowed but ignored:

        - id

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: notification_template_updateSpaceSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and space subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello,


                    You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.


                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and space subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/space/{notification-template}/notification-languages:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: List the Notification language objects
      operationId: notification_language_listSpaceSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/space/{notification-template}/notification-languages/{notification-language}:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    - $ref: '#/components/parameters/notification-language'
    get:
      summary: Get the Notification template language by name or id
      operationId: notification_language_getSpaceSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification template language object
      operationId: notification_language_updateSpaceSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
            examples:
              NotificationLanguage:
                summary: Example of notification language update at cloud scope and space subcollection.
                value:
                  title: Example notification language update
                  notification_template_name: invitation
                  notification_template_type: space
                  subject: Invitation to join Acme
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
                  - html
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/consumer:
    description: The collection of Notification Template operations
    get:
      summary: List the Notification Template objects
      operationId: notification_template_listConsumerSubcollectionCloudScope
      security:
      - oauth:
        - cloud: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/NotificationTemplateList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplateList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/consumer/{notification-template}:
    description: Notification Template object operations
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: Get the Notification Template object by name or id
      operationId: notification_template_getConsumerSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification Template object by name or id
      description: 'Update the Notification Template object by name or id


        Fields not allowed:

        - name

        - notification_template_type


        Fields allowed but ignored:

        - id

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: notification_template_updateConsumerSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and consumer subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello,


                    You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.


                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
            examples:
              NotificationTemplate:
                summary: Example of notification template update at cloud scope and consumer subcollection.
                value:
                  title: Acme notification template
                  subject: Invitation to join Acme
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/consumer/{notification-template}/notification-languages:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    get:
      summary: List the Notification language objects
      operationId: notification_language_listConsumerSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguageList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/notification-templates/consumer/{notification-template}/notification-languages/{notification-language}:
    parameters:
    - $ref: '#/components/parameters/notification-template'
    - $ref: '#/components/parameters/notification-language'
    get:
      summary: Get the Notification template language by name or id
      operationId: notification_language_getConsumerSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Notification template language object
      operationId: notification_language_updateConsumerSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
          application/yaml:
            schema:
              $ref: '#/components/schemas/NotificationLanguage'
            examples:
              NotificationLanguage:
                summary: Example of notification language update at cloud scope and consumer subcollection.
                value:
                  title: Example notification language update
                  notification_template_name: invitation
                  notification_template_type: consumer
                  subject: Invitation to join Acme
                  body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.

                    '
                  body_html: Hello,<br><br>You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.<br><br>
                  content_type:
                  - text
                  - html
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NotificationLanguage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/role-defaults:
    description: Role Default operations across all collections
    get:
      summary: List all Role Default objects in all collections
      operationId: role_default_listAllCloudScope
      security:
      - oauth:
        - cloud: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/RoleDefaultList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/RoleDefaultList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/role-defaults/provider:
    description: The collection of Role Default operations
    post:
      summary: Create a Role Default object
      description: 'Create a Role Default object


        Fields allowed but ignored:

        - id

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: role_default_createProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleDefault'
            examples:
              RoleDefault:
                summary: Example of role defaults creation.
                value:
                  role_default_type: provider
                  name: acme-role-defaults
                  title: Acme role defaults
                  summary: An example role defaults
                  permission_urls:
                  - https://acme-apim.example.com/api/cloud/permissions/org/topology:view
                  - https://acme-apim.example.com/api/cloud/permissions/provider/product-drafts:view
                  - https://acme-apim.example.com/api/cloud/permissions/deployment/product:view
          application/yaml:
            schema:
              $ref: '#/components/schemas/RoleDefault'
            examples:
              RoleDefault:
                summary: Example of role defaults creation.
                value:
                  role_default_type: provider
                  name: acme-role-defaults
                  title: Acme role defaults
                  summary: An example role defaults
                  permission_urls:
                  - https://acme-apim.example.com/api/cloud/permissions/org/topology:view
                  - https://acme-apim.example.com/api/cloud/permissions/provider/product-drafts:view
                  - https://acme-apim.example.com/api/cloud/permissions/deployment/product:view
      responses:
        '201':
          description: Successful create
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefault'
            application/yaml:
              schema:
                $ref: '#/components/schemas/RoleDefault'
        '302':
          description: Redirect response
          headers:
            Location:
              description: Redirect payload
              schema:
                type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    get:
      summary: List the Role Default objects
      operationId: role_default_listProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud: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/RoleDefaultList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/RoleDefaultList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    delete:
      summary: Clear the Role Default objects
      operationId: role_default_clearProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      parameters:
      - $ref: '#/components/parameters/confirm'
      responses:
        '204':
          description: Success
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/role-defaults/provider/{role-default}:
    description: Role Default object operations
    parameters:
    - $ref: '#/components/parameters/role-default'
    get:
      summary: Get the Role Default object by name or id
      operationId: role_default_getProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefault'
            application/yaml:
              schema:
                $ref: '#/components/schemas/RoleDefault'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    patch:
      summary: Update the Role Default object by name or id
      description: 'Update the Role Default object by name or id


        Fields allowed but ignored:

        - id

        - type

        - api_version

        - scope

        - created_at

        - updated_at

        - url'
      operationId: role_default_updateProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleDefault'
            examples:
              RoleDefault:
                summary: Example of role defaults update.
                value:
                  title: Acme role defaults update
                  summary: An example role defaults update
                  permission_urls:
                  - https://acme-apim.example.com/api/cloud/permissions/provider/product-drafts:edit
                  - https://acme-apim.example.com/api/cloud/permissions/deployment/product:stage
          application/yaml:
            schema:
              $ref: '#/components/schemas/RoleDefault'
            examples:
              RoleDefault:
                summary: Example of role defaults update.
                value:
                  title: Acme role defaults update
                  summary: An example role defaults update
                  permission_urls:
                  - https://acme-apim.example.com/api/cloud/permissions/provider/product-drafts:edit
                  - https://acme-apim.example.com/api/cloud/permissions/deployment/product:stage
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefault'
            application/yaml:
              schema:
                $ref: '#/components/schemas/RoleDefault'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    delete:
      summary: Delete the Role Default object by name or id
      operationId: role_default_delProviderSubcollectionCloudScope
      security:
      - oauth:
        - cloud:manage
      responses:
        '200':
          description: Successful delete
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefault'
            application/yaml:
              schema:
                $ref: '#/components/schemas/RoleDefault'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/role-defaults/consumer:
    description: The collection of Role Default operations
    get:
      summary: List the Role Default objects
      operationId: role_default_listConsumerSubcollectionCloudScope
      security:
      - oauth:
        - cloud: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/RoleDefaultList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/RoleDefaultList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/settings/role-defaults/consumer/{role-default}:
    description: Role Default object operations
    parameters:
    - $ref: '#/components/parameters/role-default'
    get:
      summary: Get the Role Default object by name or id
      operationId: role_default_getConsumerSubcollectionCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefault'
            application/yaml:
              schema:
                $ref: '#/components/schemas/RoleDefault'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: APIM base path
  /cloud/data-sources:
    get:
      summary: List the Data Source objects across orgs
      operationId: data_source_listCloudScope
      security:
      - oauth:
        - cloud:view
      parameters:
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/state'
      - $ref: '#/components/parameters/collector_type'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceList'
            application/yaml:
              schema:
                $ref: '#/components/schemas/DataSourceList'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: Local laptop testing
  /cloud/{org}/data-sources:
    description: Data Source object operations Cloud Scope
    parameters:
    - $ref: '#/components/parameters/org'
    post:
      summary: Create a Data Source object at Cloud Scope
      description: 'Create a Data Source object at Cloud Scope

        Fields allowed but ignored:\ - id - type - api_version - scope - created_at - updated_at - url'
      operationId: data_source_createCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSource'
          application/yaml:
            schema:
              $ref: '#/components/schemas/DataSource'
      responses:
        '201':
          description: Successful create
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
            application/yaml:
              schema:
                $ref: '#/components/schemas/DataSource'
        '302':
          description: Redirect response
          headers:
            Location:
              description: Redirect payload
              schema:
                type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: Local laptop testing
  /cloud/{org}/data-sources/{data-source}:
    description: Data Source object operations Cloud Scope
    parameters:
    - $ref: '#/components/parameters/org'
    - $ref: '#/components/parameters/data-source'
    patch:
      summary: Update the Data Source object by name or id for cloud
      description: 'Update the Data Source object by name or id for cloud

        Fields not allowed:\ - name

        Fields allowed but ignored:\ - id - type - api_version - scope - created_at - updated_at - url'
      operationId: data_source_updateCloudScope
      security:
      - oauth:
        - cloud:manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSource'
          application/yaml:
            schema:
              $ref: '#/components/schemas/DataSource'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
            application/yaml:
              schema:
                $ref: '#/components/schemas/DataSource'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: Local laptop testing
  /cloud/{org}/data-sources/limit:
    description: Data Source object operations Cloud Scope
    parameters:
    - $ref: '#/components/parameters/org'
    get:
      summary: Get remaining Data Source limit for cloud
      description: Get the current value of data sources used and the maximum value of data sources allowed for cloud
      operationId: data_source_getLimitCloudScope
      security:
      - oauth:
        - cloud:view
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceLimit'
            application/yaml:
              schema:
                $ref: '#/components/schemas/DataSourceLimit'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Cloud Settings
    servers:
    - url: ''
      description: Local laptop testing
components:
  schemas:
    NotificationTemplateList:
      type: object
      additionalProperties: false
      properties:
        total_results:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/NotificationTemplate'
    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
    Oauth2CertsResponse:
      type: object
      additionalProperties: false
      properties:
        keys:
          type: array
          items:
            $ref: '#/components/schemas/JWKDefinition'
    RoleDefaultList:
      type: object
      additionalProperties: false
      properties:
        total_results:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/RoleDefault'
    RoleDefault:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - role_default
        api_version:
          type: string
          readOnly: true
          enum:
          - 2.0.0
        id:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 255
        role_default_type:
          type: string
        title:
          type: string
          maxLength: 1023
        summary:
          type: string
          maxLength: 65535
        scope:
          type: string
        permission_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
    TransitionHelperCredentialsResponse:
      type: object
      additionalProperties: false
      required:
      - transition_helper
      properties:
        cloud_id:
          type: string
        transition_helper:
          type: object
          additionalProperties: false
          properties:
            endpoint:
              type: string
            manager_endpoint:
              type: string
            client_id:
              type: string
            client_secret:
              type: string
    ApiControlPlaneEndpointTestConnection:
      type: object
      additionalProperties: false
      properties:
        authenticationType:
          type: string
          enum:
          - basic
          - apikey
          - mTLS
        endpoint:
          $ref: '#/components/schemas/SecuredEndpoint'
        ui_endpoint:
          $ref: '#/components/schemas/SecuredEndpoint'
        credentials:
          $ref: '#/components/schemas/ControlPlaneTestConnectionCredentials'
    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
    NotificationLanguage:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - notification_language
        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
        variables:
          type: array
          items:
            type: string
        subject:
          type: string
        body:
          type: string
        body_html:
          type: string
        content_type:
          type: array
          items:
            type: string
            enum:
            - text
            - html
        notification_template_name:
          type: string
        notification_template_type:
          type: string
        org_url:
          type: string
          format: uri
        catalog_url:
          type: string
          format: uri
        space_url:
          type: string
          format: uri
        consumer_org_url:
          type: string
          format: uri
        notification_template_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
    DesignerCredentialsResponse:
      type: object
      additionalProperties: false
      required:
      - designer
      properties:
        cloud_id:
          type: string
        designer:
          type: object
          additionalProperties: false
          properties:
            endpoint:
              type: string
            manager_endpoint:
              type: string
            client_id:
              type: string
            client_secret:
              type: string
    CloudSetting:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - cloud_setting
        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
        cloud_name:
          type: string
        cloud_id:
          type: string
        mail_server_url:
          type:
          - string
          - 'null'
          format: uri
        invitation_ttl:
          type: integer
          minimum: 0
          maximum: 2147483647
        reset_password_ttl:
          type: integer
          minimum: 0
          maximum: 2147483647
        provision_sandbox_catalog:
          type: boolean
        restrict_member_manage_permission:
          type: boolean
          default: false
        access_token_expires_in:
          type: integer
          minimum: 0
          maximum: 2147483647
        refresh_token_enabled:
          type: boolean
        refresh_expires_in:
          type: integer
          minimum: 0
          maximum: 2147483647
        api_key_enabled:
          type: boolean
          default: true
        api_key_expires_in:
          type: integer
          minimum: 0
          maximum: 2147483647
        api_key_multiple_uses:
          type: boolean
        api_cp_setting:
          type: object
          additionalProperties: false
          properties:
            enabled:
              type: boolean
            apic_runtime_id:
              type:
              - string
              - 'null'
            apic_runtime_name:
              type:
              - string
              - 'null'
            endpoint:
              $ref: '#/components/schemas/SecuredEndpoint'
            ui_endpoint:
              $ref: '#/components/schemas/SecuredEndpoint'
            iam_endpoint:
              type: string
              readOnly: true
            authenticationType:
              type: string
              enum:
              - basic
              - apikey
              - mTLS
            credentials:
              type: object
              additionalProperties: false
              properties:
                username:
                  type:
                  - string
                  - 'null'
                password:
                  type:
                  - string
                  - 'null'
                  format: password
                instance_id:
                  type:
                  - string
                  - 'null'
                api_key:
                  type:
                  - string
                  - 'null'
            metrics_sync_interval:
              type: integer
              minimum: 0
              maximum: 86400
            heartbeat_interval:
              type: integer
              minimum: 0
              maximum: 86400
        sso_settings:
          type:
          - object
          - 'null'
          properties:
            enabled:
              type: boolean
            org_types:
              type:
              - array
              - 'null'
              items:
                type: string
                enum:
                - admin
                - provider
            default_org_type:
              type:
              - string
              - 'null'
              enum:
              - admin
              - provider
            user_registry_urls:
              type:
              - array
              - 'null'
              items:
                type: string
                format: uri
            default_user_registry_url:
              type:
              - string
              - 'null'
              format: uri
            registration_urls:
              type:
              - array
              - 'null'
              items:
                type: string
                format: uri
            default_registration_url:
              type:
              - string
              - 'null'
              format: uri
        audit_setting:
          type: object
          additionalProperties: false
          properties:
            enabled:
              type: boolean
            audit_reads:
              type: object
              additionalProperties: false
              properties:
                enabled:
                  type: boolean
                response_data_to_http_endpoints:
                  type: object
                  additionalProperties: false
                  properties:
                    enabled:
                      type: boolean
                    list_results_limit:
                      type: integer
                      minimum: 0
                      maximum: 10000
            mode:
              type: string
              enum:
              - block
              - non_block
            endpoints:
              type: array
              items:
                type: object
                additionalProperties: false
                properties:
                  endpoint_type:
                    type: string
                    enum:
                    - http
                    - syslog_udp
                    - syslog_tcp
                    - syslog_tls
                  endpoint:
                    $ref: '#/components/schemas/SecuredEndpoint'
                  headers:
                    type:
                    - object
                    - 'null'
                    additionalProperties:
                      type: string
                required:
                - endpoint
            analytics_service_urls:
              type: array
              items:
                type: string
                format: uri
        gateway_service_default_urls:
          type: array
          items:
            type: string
            format: uri
        cloud_manager_endpoint:
          type: string
          format: uri
        api_manager_endpoint:
          type: string
          format: uri
        platform_api_endpoint:
          type: string
          format: uri
        consumer_api_endpoint:
          type: string
          format: uri
        platform_api_svc_endpoint:
          type: string
          format: uri
        consumer_api_svc_endpoint:
          type: string
          format: uri
        license_accepted:
          type: boolean
        email_sender:
          $ref: '#/components/schemas/EmailSender'
        ibm_cloud:
          type: boolean
        service_type:
          type: string
          enum:
          - monolithic
          - microservice
        tls_client_profile_default_url:
          type: string
          format: uri
        external_tls_client_profile_url:
          type:
          - string
          - 'null'
          format: uri
          description: 'TLS Client Profile containing CA certificates for external services such as load balancers or WAFs.

            '
        token_issuer:
          type: string
        access_token_keystore_urls:
          type: array
          items:
            type: string
            format: uri
        id_token_keystore_urls:
          type: array
          items:
            type: string
            format: uri
        temporary_token_keystore_urls:
          type: array
          items:
            type: string
            format: uri
        self_signed_token_keystore_urls:
          type: array
          items:
            type: string
            format: uri
        atm_base_path:
          type:
          - string
          - 'null'
        temporary_token_format:
          type: string
          enum:
          - jwt
          - b64
        sync_roles_setting:
          type: object
          additionalProperties: false
          properties:
            enabled:
              type: boolean
            endpoint:
              $ref: '#/components/schemas/SecuredEndpoint'
        api_security_analytics_service_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
    TopologyGatewayServices:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        name:
          type: string
        gateway_service_type:
          type: string
          enum:
          - datapower-gateway
          - datapower-api-gateway
          - event-gateway
          - datapower-nano-gateway
          - wm-api-gateway
    UserRegistrySetting:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - user_registry_setting
        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
        admin_user_registry_urls:
          type: array
          items:
            type: string
            format: uri
        admin_user_registry_default_url:
          type: string
          format: uri
        provider_user_registry_urls:
          type: array
          items:
            type: string
            format: uri
        provider_user_registry_default_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
    NotificationLanguageList:
      type: object
      additionalProperties: false
      properties:
        total_results:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/NotificationLanguage'
    ToolkitCredentialsResponse:
      type: object
      additionalProperties: false
      required:
      - cloud_id
      properties:
        cloud_id:
          type: string
        toolkit:
          type: object
          properties:
            endpoint:
              type: string
            client_id:
              type: string
            client_secret:
              type: string
        consumer_toolkit:
          type: object
          properties:
            endpoint:
              type: string
            client_id:
              type: string
            client_secret:
              type: string
        governance:
          type: object
          properties:
            endpoint:
              type: string
            client_id:
              type: string
            client_secret:
              type: string
        mcp_registry:
          type: object
          properties:
            endpoint:
              type: string
            client_id:
              type: string
            client_secret:
              type: string
        discovery:
          type: object
          properties:
            endpoint:
              type: string
            client_id:
              type: string
            client_secret:
              type: string
    MailServerConfigured:
      type: object
      additionalProperties: false
      properties:
        configured:
          type: boolean
    NotificationTemplate:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - notification_template
        api_version:
          type: string
          readOnly: true
          enum:
          - 2.0.0
        id:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 255
        notification_template_type:
          type: string
        title:
          type: string
          maxLength: 1023
        summary:
          type: string
          maxLength: 65535
        scope:
          type: string
        variables:
          type: array
          items:
            type: string
        subject:
          type: string
        body:
          type: string
        body_html:
          type: string
        content_type:
          type: array
          items:
            type: string
            enum:
            - text
            - html
        org_url:
          type: string
          format: uri
        catalog_url:
          type: string
          format: uri
        space_url:
          type: string
          format: uri
        consumer_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
    NotificationStyle:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - notification_style
        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
        allowed_html_tags:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        id:
          type: string
        org_url:
          type: string
          format: uri
        catalog_url:
          type: string
          format: uri
        space_url:
          type: string
          format: uri
        consumer_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
    EmailSender:
      type: object
      additionalProperties: false
      properties:
        custom:
          type: boolean
        name:
          type: string
        address:
          type: string
    ControlPlaneTestConnectionCredentials:
      type: object
      additionalProperties: false
      properties:
        username:
          type: string
        password:
          type: string
          format: password
        instance_id:
          type: string
        api_key:
          type: string
    TopologyCatalogs:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        name:
          type: string
        title:
          type: string
        summary:
          type: string
        url:
          type: string
        counts:
          type: object
          additionalProperties: true
          properties:
            members:
              type: integer
              minimum: 0
              maximum: 2147483647
            apps:
              type: integer
              minimum: 0
              maximum: 2147483647
            subscriptions:
              type: integer
              minimum: 0
              maximum: 2147483647
            consumer_orgs:
              type: integer
              minimum: 0
              maximum: 2147483647
            products:
              type: integer
              minimum: 0
              maximum: 2147483647
            apis:
              type: integer
              minimum: 0
              maximum: 2147483647
            product_lifecycle_states:
              type: object
              additionalProperties: true
              properties:
                staged:
                  type: integer
                  minimum: 0
                  maximum: 2147483647
                published:
                  type: integer
                  minimum: 0
                  maximum: 2147483647
                deprecated:
                  type: integer
                  minimum: 0
                  maximum: 2147483647
                retired:
                  type: integer
                  minimum: 0
                  maximum: 2147483647
                archived:
                  type: integer
                  minimum: 0
                  maximum: 2147483647
        consumer_org_list_url:
          type: string
        gateway_service_types:
          type: object
          additionalProperties: true
          properties:
            total_results:
              type: integer
              minimum: 0
              maximum: 2147483647
            results:
              type: array
              items:
                $ref: '#/components/schemas/TopologyGatewayServices'
        portal_service_types:
          type: object
          additionalProperties: true
          properties:
            total_results:
              type: integer
              minimum: 0
              maximum: 2147483647
            results:
              type: array
              items:
                $ref: '#/components/schemas/TopologyPortalServices'
        spaces:
          type: object
          additionalProperties: true
          properties:
            total_results:
              type: integer
              minimum: 0
              maximum: 2147483647
            results:
              type: array
              items:
                $ref: '#/components/schemas/TopologySpaces'
    TopologyPortalServices:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        name:
          type: string
        portal_service_type:
          type: string
          enum:
          - cms
          - devportal
    TopologyProviderOrg:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        name:
          type: string
        title:
          type: string
        summary:
          type: string
        state:
          type: string
        org_type:
          type: string
        runtime_api_opt_in_datagather_enabled:
          type: boolean
        owner_url:
          type: string
        owner:
          type: object
          additionalProperties: true
          properties:
            email:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        counts:
          type: object
          additionalProperties: true
          properties:
            members:
              type: integer
              minimum: 0
              maximum: 2147483647
            draft_products:
              type: integer
              minimum: 0
              maximum: 2147483647
            draft_apis:
              type: integer
              minimum: 0
              maximum: 2147483647
        catalogs:
          type: object
          additionalProperties: true
          properties:
            total_results:
              type: integer
              minimum: 0
              maximum: 2147483647
            results:
              type: array
              items:
                $ref: '#/components/schemas/TopologyCatalogs'
    CloudPublicInfo:
      type: object
      additionalProperties: false
      required:
      - cloud_id
      properties:
        cloud_id:
          type: string
        admin_endpoint:
          type: string
        provider_endpoint:
          type: string
        api_endpoint:
          type: string
        consumer_api_endpoint:
          type: string
        compliance_endpoint:
          type: string
        discovery_endpoint:
          type: string
        mcp_registry_endpoint:
          type: string
        external_tls_client_profile_ca:
          type: string
          description: 'CA certificate(s) from the external TLS client profile for validating connections to external services such as load balancers or WAFs.

            '
    TopologySpaces:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        name:
          type: string
        title:
          type: string
        summary:
          type: string
        url:
          type: string
        counts:
          type: object
          additionalProperties: true
          properties:
            products:
              type: integer
              minimum: 0
              maximum: 2147483647
            apis:
              type: integer
              minimum: 0
              maximum: 2147483647
        gateway_service_types:
          type: object
          additionalProperties: true
          properties:
            total_results:
              type: integer
              minimum: 0
              maximum: 2147483647
            results:
              type: array
              items:
                $ref: '#/components/schemas/TopologyGatewayServices'
        portal_service_types:
          type: object
          additionalProperties: true
          properties:
            total_results:
              type: integer
              minimum: 0
              maximum: 2147483647
            results:
              type: array
              items:
                $ref: '#/components/schemas/TopologyPortalServices'
    CloudAbout:
      type: object
      additionalProperties: false
      properties:
        product_version:
          type: object
          additionalProperties: false
          properties:
            version:
              type: string
            operator_build_date:
              type: string
              format: date-time
            operator_build_tag:
              type: string
            operator_version:
              type: string
        cloud:
          type: object
          additionalProperties: false
          properties:
            name:
              type: string
            title:
              type: string
        upgrade_history:
          type: object
          additionalProperties: false
          properties:
            apim:
              type: object
              additionalProperties: false
              properties:
                schema_upgrades:
                  type: array
                  items:
                    type: object
                    additionalProperties: false
                    properties:
                      schema_version:
                        type: string
                      target_schema_version:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
                data_upgrades:
                  type: array
                  items:
                    type: object
                    additionalProperties: false
                    properties:
                      data_version:
                        type: string
                      target_data_version:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
            lur:
              type: object
              additionalProperties: false
              properties:
                schema_upgrades:
                  type: array
                  items:
                    type: object
                    additionalProperties: false
                    properties:
                      schema_version:
                        type: string
                      target_schema_version:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
                data_upgrades:
                  type: array
                  items:
                    type: object
                    additionalProperties: false
                    properties:
                      data_version:
                        type: string
                      target_data_version:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
    SecuredEndpoint:
      type:
      - object
      - 'null'
      additionalProperties: false
      required:
      - endpoint
      properties:
        endpoint:
          type: string
          format: uri
        tls_client_profile_url:
          type:
          - string
          - 'null'
          format: uri
    AuditEndpointTestConnection:
      type: object
      additionalProperties: false
      properties:
        endpoint:
          type: string
          format: uri
    CloudTopology:
      type: object
      additionalProperties: true
      properties:
        title:
          type: string
          maxLength: 1023
        cloud_name:
          type: string
        cloud_id:
          type: string
        counts:
          type: object
          additionalProperties: true
          properties:
            users:
              type: integer
              minimum: 0
              maximum: 2147483647
            provider_orgs:
              type: integer
              minimum: 0
              maximum: 2147483647
            catalogs:
              type: integer
              minimum: 0
              maximum: 2147483647
            draft_products:
              type: integer
              minimum: 0
              maximum: 2147483647
            draft_apis:
              type: integer
              minimum: 0
              maximum: 2147483647
            apis:
              type: integer
              minimum: 0
              maximum: 2147483647
            products:
              type: integer
              minimum: 0
              maximum: 2147483647
            consumer_orgs:
              type: integer
              minimum: 0
              maximum: 2147483647
            subscriptions:
              type: integer
              minimum: 0
              maximum: 2147483647
            consumer_apps:
              type: integer
              minimum: 0
              maximum: 2147483647
            spaces:
              type: integer
              minimum: 0
              maximum: 2147483647
        orgs:
          type: object
          additionalProperties: true
          properties:
            total_results:
              type: integer
              minimum: 0
              maximum: 2147483647
            results:
              type: array
              items:
                $ref: '#/components/schemas/TopologyProviderOrg'
            url:
              type: string
    DataSourceList:
      type: object
      additionalProperties: false
      properties:
        total_results:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/DataSource'
    DataSource:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - data_source
        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
        description:
          type: string
          maxLength: 65535
        state:
          type: string
          enum:
          - enabled
          - disabled
          - paused
          - unhealthy
        source_address:
          type: string
        collector_type:
          type: string
        source_id:
          type: string
        last_run:
          type: string
          format: date-time
        message:
          type: string
        options:
          type: object
          additionalProperties: true
          properties:
            gen_api_grouping:
              type: string
              enum:
              - path0
              - server-based
            gen_api_sensitivity:
              type: number
            auto_promote:
              type: boolean
              default: false
        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
    DataSourceLimit:
      type: object
      additionalProperties: false
      properties:
        data_sources:
          type: integer
        max_data_source_limit:
          type: integer
  parameters:
    limit:
      name: limit
      in: query
      description: Maximum number of items to return
      required: false
      schema:
        type: integer
    fields:
      name: fields
      in: query
      description: List of field names to return
      required: false
      schema:
        type: string
    notification-language:
      name: notification-language
      in: path
      description: Notification Language name or id
      required: true
      schema:
        type: string
    offset:
      name: offset
      in: query
      description: Offset item number from list to begin return
      required: false
      schema:
        type: integer
    notification-template:
      name: notification-template
      in: path
      description: Notification Template name or id
      required: true
      schema:
        type: string
    confirm:
      name: confirm
      in: query
      description: Confirmation for critical updates
      required: true
      schema:
        type: string
    role-default:
      name: role-default
      in: path
      description: Role Default name or id
      required: true
      schema:
        type: string
    collector_type:
      name: collector_type
      in: query
      description: Optional collector_type to use to filter the list of Datasources
      required: false
      schema:
        type: string
    data-source:
      name: data-source
      in: path
      description: Data Source name or id
      required: true
      schema:
        type: string
    state:
      name: state
      in: query
      description: Optional state to use to filter Discovered API lists
      required: false
      schema:
        type: string
    org:
      name: org
      in: path
      description: Organization name or id
      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
externalDocs:
  description: Additional documentation
  url: https://www.ibm.com/knowledge-center/api-connect/platform-apis
x-refined-from:
- ibm-api-connect-cloud-management-api-openapi.yml
- ibm-api-connect-discovery-api-openapi.yml
x-ibm-configuration:
  testable: false