openapi: 3.2.0 info: title: Ibm Api Connect Consumer Management 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 Consumer Management across 2 of this provider''s published API definitions: ibm-api-connect-consumer-api-openapi.yml, ibm-api-connect-management-api-openapi.yml. Each path carries the servers of the definition it was published in.' tags: - name: Consumer Management paths: /groups/{group}: description: Group object operations parameters: - $ref: '#/components/parameters/group' get: summary: Get the Group object by name or id operationId: group_get security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Group' application/yaml: schema: $ref: '#/components/schemas/Group' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: Consumer apim base path /catalogs/{org}/{catalog}/apps: description: The collection of Application operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a Application object description: 'Create a Application object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: app_createCatalogScope security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer apps description: Returns a list of apps belonging to the given consumer org in a catalog. operationId: app_listCatalogScope security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/expand' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AppList' application/yaml: schema: $ref: '#/components/schemas/AppList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clear the Application objects operationId: app_clearCatalogScope security: - oauth: - app:manage:all parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /catalogs/{org}/{catalog}/apps/{app}: description: Application object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/app' get: summary: Get the Application object by name or id operationId: app_getCatalogScope security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Update the Application object by name or id description: 'Update the Application object by name or id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: app_updateCatalogScope security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Delete the Application object by name or id operationId: app_delCatalogScope security: - oauth: - app:manage:all responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /spaces/{org}/{catalog}/{space}/apps: description: The collection of Application operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' post: summary: Create a Application object description: 'Create a Application object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: app_createSpaceScope security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer apps description: Returns a list of apps belonging in the given catalog as accessed through the given space. operationId: app_listSpaceScope security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/expand' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AppList' application/yaml: schema: $ref: '#/components/schemas/AppList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clear the Application objects operationId: app_clearSpaceScope security: - oauth: - app:manage:all parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /spaces/{org}/{catalog}/{space}/apps/{app}: description: Application object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/app' get: summary: Get the Application object by name or id operationId: app_getSpaceScope security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Update the Application object by name or id description: 'Update the Application object by name or id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: app_updateSpaceScope security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Delete the Application object by name or id operationId: app_delSpaceScope security: - oauth: - app:manage:all responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/settings: description: Consumer Organization Setting object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' get: summary: Returns consumer organization settings description: Returns the settings for the given consumer organization in a catalog. operationId: consumer_org_setting_singletonGet security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgSetting' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgSetting' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management put: summary: Updates consumer organization settings description: 'Updates the settings for the given consumer organization in a catalog. Fields allowed but ignored: - name - type - api_version - scope - created_at - updated_at - url' operationId: consumer_org_setting_singletonUpdate security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgSetting' examples: ConsumerOrgSetting: summary: Example consumer-org setting update at catalog scope. value: invitation_ttl: 172800 application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgSetting' examples: ConsumerOrgSetting: summary: Example consumer-org setting update at catalog scope. value: invitation_ttl: 172800 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgSetting' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgSetting' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes consumer organization settings description: Deletes the settings from the given consumer organization in a catalog. operationId: consumer_org_setting_singletonDel security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgSetting' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgSetting' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings: description: Consumer Organization Setting object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' get: summary: Returns consumer organization settings description: Returns the settings for the given consumer organization in a catalog, as accessed through a space. operationId: consumer_org_setting_singletonGetSpaceInitiated security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgSetting' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgSetting' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management put: summary: Updates consumer organization settings description: 'Updates the settings for the given consumer organization in a catalog, as accessed through a space. Fields allowed but ignored: - name - type - api_version - scope - created_at - updated_at - url' operationId: consumer_org_setting_singletonUpdateSpaceInitiated security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgSetting' examples: ConsumerOrgSetting: summary: Example consumer-org setting update at space scope. value: invitation_ttl: 172800 application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgSetting' examples: ConsumerOrgSetting: summary: Example consumer-org setting update at space scope. value: invitation_ttl: 172800 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgSetting' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgSetting' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes consumer organization settings description: Deletes the settings from the given consumer organization in a catalog, as accessed through a space. operationId: consumer_org_setting_singletonDelSpaceInitiated security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgSetting' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgSetting' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /catalogs/{org}/{catalog}/consumer-org-invitations: description: The collection of Consumer Organization Invitation operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a Consumer Organization Invitation object description: 'Creates a consumer organization owner invitation in the context of a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url' operationId: invitation_createConsumerOrgScope security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Invitation' examples: Invitation: summary: Example of invitation creation at consumer-org scope. value: name: acme-invitation title: Acme invitation summary: An example invitation creation at consumer-org scope notify: true email: acme@example.com application/yaml: schema: $ref: '#/components/schemas/Invitation' examples: Invitation: summary: Example of invitation creation at consumer-org scope. value: name: acme-invitation title: Acme invitation summary: An example invitation creation at consumer-org scope notify: true email: acme@example.com responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer organization invitations description: Returns the list of all consumer organization owner invitations in the context of a catalog. operationId: invitation_listConsumerOrgScope security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InvitationList' application/yaml: schema: $ref: '#/components/schemas/InvitationList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears consumer organization invitations description: Removes all consumer organization owner invitations from a catalog. operationId: invitation_clearConsumerOrgScope security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}: description: Consumer Organization Invitation object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/invitation' get: summary: Returns a consumer organization invitation description: Returns a consumer organization owner invitation in the context of a catalog. operationId: invitation_getConsumerOrgScope security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer organization invitation description: 'Updates a consumer organization owner invitation in the context of a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url' operationId: invitation_updateConsumerOrgScope security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Invitation' examples: Invitation: summary: Example of invitation update at consumer-org scope. value: title: Acme invitation summary: An example invitation update at consumer-org scope email: acme@example.com application/yaml: schema: $ref: '#/components/schemas/Invitation' examples: Invitation: summary: Example of invitation update at consumer-org scope. value: title: Acme invitation summary: An example invitation update at consumer-org scope email: acme@example.com responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer organization invitation description: Deletes a consumer organization owner invitation in the context of a catalog. operationId: invitation_delConsumerOrgScope security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}/regenerate: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/invitation' post: summary: Regenerate the Consumer Organization Invitation operationId: invitation_regenerateConsumerOrgScope security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Regenerate' application/yaml: schema: $ref: '#/components/schemas/Regenerate' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /spaces/{org}/{catalog}/{space}/consumer-org-invitations: description: The collection of Consumer Organization Invitation operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' post: summary: Creates a consumer organization invitation description: 'Creates a consumer organization owner invitation in the context of a catalog, as accessed through a space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url' operationId: invitation_createConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Invitation' examples: Invitation: summary: Example of invitation creation at consumer-org(space-initiated) scope. value: name: acme-invitation title: Acme invitation summary: An example invitation creation at consumer-org(space-initiated) scope notify: true email: acme@example.com application/yaml: schema: $ref: '#/components/schemas/Invitation' examples: Invitation: summary: Example of invitation creation at consumer-org(space-initiated) scope. value: name: acme-invitation title: Acme invitation summary: An example invitation creation at consumer-org(space-initiated) scope notify: true email: acme@example.com responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer organization invitations description: Returns the list of all consumer organization owner invitations in the context of a catalog, as accessed through a space. operationId: invitation_listConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InvitationList' application/yaml: schema: $ref: '#/components/schemas/InvitationList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears consumer organization invitations description: Removes all consumer organization owner invitations from a catalog, as accessed through a space. operationId: invitation_clearConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}: description: Consumer Organization Invitation object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/invitation' get: summary: Returns a consumer organization invitation description: Returns a consumer organization owner invitation in the context of a catalog, as accessed through a space. operationId: invitation_getConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer organization invitation description: 'Updates a consumer organization owner invitation in the context of a catalog, as accessed through a space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url' operationId: invitation_updateConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Invitation' examples: Invitation: summary: Example of invitation update at consumer-org(space-initiated) scope. value: title: Acme invitation summary: An example invitation update at consumer-org(space-initiated) scope email: acme@example.com application/yaml: schema: $ref: '#/components/schemas/Invitation' examples: Invitation: summary: Example of invitation update at consumer-org(space-initiated) scope. value: title: Acme invitation summary: An example invitation update at consumer-org(space-initiated) scope email: acme@example.com responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer organization invitation description: Deletes a consumer organization owner invitation in the context of a catalog, as accessed through a space. operationId: invitation_delConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}/regenerate: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/invitation' post: summary: Regenerate the Consumer Organization Invitation operationId: invitation_regenerateConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Regenerate' application/yaml: schema: $ref: '#/components/schemas/Regenerate' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Invitation' application/yaml: schema: $ref: '#/components/schemas/Invitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /catalogs/{org}/{catalog}/consumer-orgs: description: The collection of Consumer Organization operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Creates a consumer organization description: 'Creates a consumer organization in a catalog. Required fields: - owner_url Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url' operationId: consumer_org_create security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' examples: ConsumerOrgCatalog: summary: Example consumer org create at catalog scope. value: name: acme-consumer-org title: ACME Consumer Org summary: An example consumer org create owner_url: https://api.acme-apim.example.com/api/user-registries/acme-org/acme-user-registry/users/acme-user application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' examples: ConsumerOrgCatalog: summary: Example consumer org create at catalog scope. value: name: acme-consumer-org title: ACME Consumer Org summary: An example consumer org create owner_url: https://api.acme-apim.example.com/api/user-registries/acme-org/acme-user-registry/users/acme-user responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer organizations description: Returns the list of consumer organization from a catalog. operationId: consumer_org_list security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/expand' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgList' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears consumer organizations description: Removes all consumer organizations from a catalog. operationId: consumer_org_clear security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}: description: Consumer Organization object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' get: summary: Returns a consumer organization description: Returns the given consumer organization from a catalog. operationId: consumer_org_get security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer organization description: 'Updates a consumer organization in a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url' operationId: consumer_org_update security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/fields_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' examples: ConsumerOrgCatalog: summary: Example consumer org update at catalog scope. value: title: ACME Consumer Org Updated summary: An example consumer org update application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' examples: ConsumerOrgCatalog: summary: Example consumer org update at catalog scope. value: title: ACME Consumer Org Updated summary: An example consumer org update responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer organization description: Deletes a consumer organization from a catalog. operationId: consumer_org_del security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/transfer-owner: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' post: summary: Transfer owner to an associate operationId: consumer_org_transferOwner security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/cascade' - $ref: '#/components/parameters/delete_old_owner' requestBody: content: application/json: schema: $ref: '#/components/schemas/TransferOwner' application/yaml: schema: $ref: '#/components/schemas/TransferOwner' examples: TransferOwnerMember: summary: Example of owner transfer using member url at catalog scope. value: new_owner_member_url: https://api.acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/members/acme-member TransferOwnerAssociate: summary: Example of owner transfer using associate url at catalog scope. value: new_owner_associate_url: https://api.acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/associates/acme-associate responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /spaces/{org}/{catalog}/{space}/consumer-orgs: description: The collection of Consumer Organization operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' post: summary: Creates a consumer organization description: 'Creates a consumer organization in a catalog, as accessed through the given space. Required fields: - owner_url Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url' operationId: consumer_org_createSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' examples: ConsumerOrgCatalog: summary: Example consumer org create at space scope. value: name: acme-consumer-org title: ACME Consumer Org summary: An example consumer org create owner_url: https://api.acme-apim.example.com/api/user-registries/acme-org/acme-user-registry/users/acme-user application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' examples: ConsumerOrgCatalog: summary: Example consumer org create at space scope. value: name: acme-consumer-org title: ACME Consumer Org summary: An example consumer org create owner_url: https://api.acme-apim.example.com/api/user-registries/acme-org/acme-user-registry/users/acme-user responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer organizations description: Returns the list of consumer organization from a catalog, as accesed through a space. operationId: consumer_org_listSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/expand' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgList' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears consumer organizations description: Removes all consumer organizations from a catalog, as accessed through the given space. operationId: consumer_org_clearSpaceInitiated security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}: description: Consumer Organization object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' get: summary: Returns a consumer organization description: Returns the given consumer organization from a catalog, as accesed through a space. operationId: consumer_org_getSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer organization description: 'Updates a consumer organization in a catalog, as accessed through a space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url' operationId: consumer_org_updateSpaceInitiated security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/fields_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' examples: ConsumerOrgCatalog: summary: Example consumer org update at space scope. value: title: ACME Consumer Org Updated summary: An example consumer org update application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' examples: ConsumerOrgCatalog: summary: Example consumer org update at space scope. value: title: ACME Consumer Org Updated summary: An example consumer org update responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer organization description: Deletes a consumer organization from a catalog, as accessed through the given space. operationId: consumer_org_delSpaceInitiated security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/transfer-owner: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' post: summary: Transfer owner to an associate operationId: consumer_org_transferOwnerSpaceInitiated security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/cascade' - $ref: '#/components/parameters/delete_old_owner' requestBody: content: application/json: schema: $ref: '#/components/schemas/TransferOwner' application/yaml: schema: $ref: '#/components/schemas/TransferOwner' examples: TransferOwnerMember: summary: Example of owner transfer using member url at space scope. value: new_owner_member_url: https://api.acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/members/acme-member TransferOwnerAssociate: summary: Example of owner transfer using associate url at space scope. value: new_owner_associate_url: https://api.acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/associates/acme-associate responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConsumerOrg' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrg' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /catalogs/{org}/{catalog}/consumer-groups: description: The collection of Group operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Creates a consumer group description: 'Adds a consumer group to a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: group_createCatalogScope security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Group_2' examples: Group: summary: Example of group creation at catalog scope. value: name: acme-group title: Acme group creation summary: An example group creation org_urls: - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1 application/yaml: schema: $ref: '#/components/schemas/Group_2' examples: Group: summary: Example of group creation at catalog scope. value: name: acme-group title: Acme group creation summary: An example group creation org_urls: - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Group_2' application/yaml: schema: $ref: '#/components/schemas/Group_2' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer groups description: Returns the list of consumer groups in a catalog. operationId: group_listCatalogScope security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GroupList' application/yaml: schema: $ref: '#/components/schemas/GroupList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears consumer groups description: Removes all consumer groups from a catalog. operationId: group_clearCatalogScope security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /catalogs/{org}/{catalog}/consumer-groups/{group}: description: Group object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/group' get: summary: Returns a consumer group description: Returns a consumer group in a catalog. operationId: group_getCatalogScope security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Group_2' application/yaml: schema: $ref: '#/components/schemas/Group_2' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer group description: 'Updates a consumer group in a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: group_updateCatalogScope security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Group_2' examples: Group: summary: Example of group update at catalog scope. value: title: Acme group update summary: An example group update org_urls: - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1 - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org2 application/yaml: schema: $ref: '#/components/schemas/Group_2' examples: Group: summary: Example of group update at catalog scope. value: title: Acme group update summary: An example group update org_urls: - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1 - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org2 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Group_2' application/yaml: schema: $ref: '#/components/schemas/Group_2' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer group description: Removes a consumer group from a catalog. operationId: group_delCatalogScope security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Group_2' application/yaml: schema: $ref: '#/components/schemas/Group_2' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /spaces/{org}/{catalog}/{space}/consumer-groups: description: The collection of Group operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' post: summary: Create a Group object description: 'Create a Group object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: group_createSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Group_2' examples: Group: summary: Example of group creation at space scope. value: name: acme-group title: Acme group creation summary: An example group creation org_urls: - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1 application/yaml: schema: $ref: '#/components/schemas/Group_2' examples: Group: summary: Example of group creation at space scope. value: name: acme-group title: Acme group creation summary: An example group creation org_urls: - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Group_2' application/yaml: schema: $ref: '#/components/schemas/Group_2' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: List the Group objects operationId: group_listSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GroupList' application/yaml: schema: $ref: '#/components/schemas/GroupList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clear the Group objects operationId: group_clearSpaceInitiated security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /spaces/{org}/{catalog}/{space}/consumer-groups/{group}: description: Group object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/group' get: summary: Get the Group object by name or id operationId: group_getSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Group_2' application/yaml: schema: $ref: '#/components/schemas/Group_2' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Update the Group object by name or id description: 'Update the Group object by name or id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url' operationId: group_updateSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Group_2' examples: Group: summary: Example of group update at space scope. value: title: Acme group update summary: An example group update org_urls: - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1 - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org2 application/yaml: schema: $ref: '#/components/schemas/Group_2' examples: Group: summary: Example of group update at space scope. value: title: Acme group update summary: An example group update org_urls: - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1 - https://api.acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org2 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Group_2' application/yaml: schema: $ref: '#/components/schemas/Group_2' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Delete the Group object by name or id operationId: group_delSpaceInitiated security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Group_2' application/yaml: schema: $ref: '#/components/schemas/Group_2' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods: description: The collection of Payment Method operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' post: summary: Create a Payment Method object description: 'Create a Payment Method object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - consumer_org_url' operationId: payment_method_create security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' examples: PaymentMethod: summary: Example of payment method creation. value: name: acme-payment title: Acme payment method creation summary: An example payment method creation billing_url: https://api.acme-apim.example.com/api/catalogs/org/acme-catalog/configured-billings/configured-billing configuration: account_name: Acme Steve account_email: acme@example.com account_currency: USD account_company: XYZ account_phone: (919) 555 6789 application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' examples: PaymentMethod: summary: Example of payment method creation. value: name: acme-payment title: Acme payment method creation summary: An example payment method creation billing_url: https://api.acme-apim.example.com/api/catalogs/org/acme-catalog/configured-billings/configured-billing configuration: account_name: Acme Steve account_email: acme@example.com account_currency: USD account_company: XYZ account_phone: (919) 555 6789 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: List the Payment Method objects operationId: payment_method_list security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PaymentMethodList' application/yaml: schema: $ref: '#/components/schemas/PaymentMethodList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method}: description: Payment Method object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/payment-method' get: summary: Get the Payment Method object by name or id operationId: payment_method_get security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Update the Payment Method object by name or id description: 'Update the Payment Method object by name or id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - consumer_org_url' operationId: payment_method_update security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' examples: PaymentMethod: summary: Example of payment method update. value: title: Acme payment method update summary: An example payment method update billing_url: https://api.acme-apim.example.com/api/catalogs/org/acme-catalog/configured-billings/configured-billing configuration: account_name: Acme Steve account_email: acme@example.com account_currency: USD account_company: XYZ account_phone: (919) 555 6789 application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' examples: PaymentMethod: summary: Example of payment method update. value: title: Acme payment method update summary: An example payment method update billing_url: https://api.acme-apim.example.com/api/catalogs/org/acme-catalog/configured-billings/configured-billing configuration: account_name: Acme Steve account_email: acme@example.com account_currency: USD account_company: XYZ account_phone: (919) 555 6789 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Delete the Payment Method object by name or id operationId: payment_method_del security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/payment-methods: description: The collection of Payment Method operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' post: summary: Create a Payment Method object description: 'Create a Payment Method object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - consumer_org_url' operationId: payment_method_createSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' examples: PaymentMethod: summary: Example of payment method creation. value: name: acme-payment title: Acme payment method creation summary: An example payment method creation billing_url: https://api.acme-apim.example.com/api/catalogs/org/acme-catalog/configured-billings/configured-billing configuration: account_name: Acme Steve account_email: acme@example.com account_currency: USD account_company: XYZ account_phone: (919) 555 6789 application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' examples: PaymentMethod: summary: Example of payment method creation. value: name: acme-payment title: Acme payment method creation summary: An example payment method creation billing_url: https://api.acme-apim.example.com/api/catalogs/org/acme-catalog/configured-billings/configured-billing configuration: account_name: Acme Steve account_email: acme@example.com account_currency: USD account_company: XYZ account_phone: (919) 555 6789 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: List the Payment Method objects operationId: payment_method_listSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PaymentMethodList' application/yaml: schema: $ref: '#/components/schemas/PaymentMethodList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/payment-methods/{payment-method}: description: Payment Method object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/payment-method' get: summary: Get the Payment Method object by name or id operationId: payment_method_getSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Update the Payment Method object by name or id description: 'Update the Payment Method object by name or id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - consumer_org_url' operationId: payment_method_updateSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' examples: PaymentMethod: summary: Example of payment method update. value: title: Acme payment method update summary: An example payment method update billing_url: https://api.acme-apim.example.com/api/catalogs/org/acme-catalog/configured-billings/configured-billing configuration: account_name: Acme Steve account_email: acme@example.com account_currency: USD account_company: XYZ account_phone: (919) 555 6789 application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' examples: PaymentMethod: summary: Example of payment method update. value: title: Acme payment method update summary: An example payment method update billing_url: https://api.acme-apim.example.com/api/catalogs/org/acme-catalog/configured-billings/configured-billing configuration: account_name: Acme Steve account_email: acme@example.com account_currency: USD account_company: XYZ account_phone: (919) 555 6789 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Delete the Payment Method object by name or id operationId: payment_method_delSpaceInitiated security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' application/yaml: schema: $ref: '#/components/schemas/PaymentMethod' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/roles: description: The collection of Role operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' get: summary: Lists consumer organization roles description: Returns the list of roles for consumer organization in a catalog. operationId: role_listConsumerOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RoleList' application/yaml: schema: $ref: '#/components/schemas/RoleList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}: description: Role object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/role' get: summary: Returns a consumer organization role description: Returns a role from a consumer organization in a catalog. operationId: role_getConsumerOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Role' application/yaml: schema: $ref: '#/components/schemas/Role' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles: description: The collection of Role operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' get: summary: Lists consumer organization roles description: Returns the list of roles for consumer organization in a catalog, as accessed through a space. operationId: role_listConsumerOrgScopeSpaceInitiated security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RoleList' application/yaml: schema: $ref: '#/components/schemas/RoleList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}: description: Role object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/role' get: summary: Returns a consumer organization role description: Returns a role from a consumer organization in a catalog, as accessed through a space. operationId: role_getConsumerOrgScopeSpaceInitiated security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Role' application/yaml: schema: $ref: '#/components/schemas/Role' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/associates: description: The collection of Associate operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' get: summary: Lists associates description: Returns a list of associates of the given consumer org in a catalog. operationId: associate_listConsumerOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateList' application/yaml: schema: $ref: '#/components/schemas/AssociateList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/associates/{associate}: description: Associate object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/associate' get: summary: Returns an associate description: Returns an associate of the given consumer org in a catalog. operationId: associate_getConsumerOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Associate' application/yaml: schema: $ref: '#/components/schemas/Associate' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates: description: The collection of Associate operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' get: summary: Lists associates description: Returns a list of associates of the given consumer org in a catalog, as accessed through the given space. operationId: associate_listConsumerOrgScopeSpaceInitiated security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateList' application/yaml: schema: $ref: '#/components/schemas/AssociateList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates/{associate}: description: Associate object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/associate' get: summary: Returns an associate description: Returns an associate of the given consumer org in a catalog, as accessed through the given space. operationId: associate_getConsumerOrgScopeSpaceInitiated security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Associate' application/yaml: schema: $ref: '#/components/schemas/Associate' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations: description: The collection of Member Invitation operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' post: summary: Creates a consummer organization member invitation description: 'Creates a member invitation to a consumer organization in a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url - consumer_org_url' operationId: member_invitation_createConsumerOrgScope security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' examples: MemberInvitation: summary: Example of member invitation creation at consumer-org scope. value: name: acme-invitation title: Acme member invitation summary: An example member invitation email: acme@example.com role_urls: - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role2 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role3 notify: true application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' examples: MemberInvitation: summary: Example of member invitation creation at consumer-org scope. value: name: acme-invitation title: Acme member invitation summary: An example member invitation email: acme@example.com role_urls: - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role2 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role3 notify: true responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer organization member invitations description: Returns the list of member invitations for a consumer organization in a catalog. operationId: member_invitation_listConsumerOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberInvitationList' application/yaml: schema: $ref: '#/components/schemas/MemberInvitationList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears consumer organization member invitations description: Removes all member invitations for a consumer organization in a catalog. operationId: member_invitation_clearConsumerOrgScope security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}: description: Member Invitation object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/member-invitation' get: summary: Returns a consumer organization member invitation description: Returns a member invitation to a consumer organization in a catalog. operationId: member_invitation_getConsumerOrgScope security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer organization member invitation description: 'Updates a member invitation to a consumer organization in a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url - consumer_org_url' operationId: member_invitation_updateConsumerOrgScope security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' examples: MemberInvitation: summary: Example of member invitation update at consumer-org scope. value: title: Acme member invitation update summary: An example member invitation update email: acme1@example.com role_urls: - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role3 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role4 application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' examples: MemberInvitation: summary: Example of member invitation update at consumer-org scope. value: title: Acme member invitation update summary: An example member invitation update email: acme1@example.com role_urls: - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role3 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/consumer-org1/roles/role4 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Creates a consumer organization member invitation description: Deletes a member invitation to a consumer organization in a catalog. operationId: member_invitation_delConsumerOrgScope security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}/regenerate: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/member-invitation' post: summary: Regenerate the Member Invitation operationId: member_invitation_regenerateConsumerOrgScope security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Regenerate' application/yaml: schema: $ref: '#/components/schemas/Regenerate' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations: description: The collection of Member Invitation operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' post: summary: Creates a consummer organization member invitation description: 'Creates a member invitation to a consumer organization in a catalog, as accessed through a space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url - consumer_org_url' operationId: member_invitation_createConsumerOrgScopeSpaceInitiated security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' examples: MemberInvitation: summary: Example of member invitation creation at consumer-org(space initiated) scope. value: name: acme-invitation title: Acme member invitation summary: An example member invitation email: acme@example.com role_urls: - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role2 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role3 notify: true application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' examples: MemberInvitation: summary: Example of member invitation creation at consumer-org(space initiated) scope. value: name: acme-invitation title: Acme member invitation summary: An example member invitation email: acme@example.com role_urls: - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role2 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role3 notify: true responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer organization member invitations description: Returns the list of member invitations for a consumer organization in a catalog, as accessed through a space. operationId: member_invitation_listConsumerOrgScopeSpaceInitiated security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberInvitationList' application/yaml: schema: $ref: '#/components/schemas/MemberInvitationList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears consumer organization member invitations description: Removes all member invitations for a consumer organization in a catalog, as accessed through a space. operationId: member_invitation_clearConsumerOrgScopeSpaceInitiated security: - oauth: - org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}: description: Member Invitation object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/member-invitation' get: summary: Returns a consumer organization member invitation description: Returns a member invitation to a consumer organization in a catalog, as accessed through a space. operationId: member_invitation_getConsumerOrgScopeSpaceInitiated security: - oauth: - org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer organization member invitation description: 'Updates a member invitation to a consumer organization in a catalog, as accessed through a space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url - consumer_org_url' operationId: member_invitation_updateConsumerOrgScopeSpaceInitiated security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' examples: MemberInvitation: summary: Example of member invitation update at consumer-org(space initiated) scope. value: title: Acme member invitation update summary: An example member invitation update email: acme1@example.com role_urls: - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role2 application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' examples: MemberInvitation: summary: Example of member invitation update at consumer-org(space initiated) scope. value: title: Acme member invitation update summary: An example member invitation update email: acme1@example.com role_urls: - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/org1/catalog1/space1/consumer-org1/roles/role2 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer organization member invitation description: Deletes a member invitation to a consumer organization in a catalog, as accessed through a space. operationId: member_invitation_delConsumerOrgScopeSpaceInitiated security: - oauth: - org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}/regenerate: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/member-invitation' post: summary: Regenerate the Member Invitation operationId: member_invitation_regenerateConsumerOrgScopeSpaceInitiated security: - oauth: - org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Regenerate' application/yaml: schema: $ref: '#/components/schemas/Regenerate' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberInvitation' application/yaml: schema: $ref: '#/components/schemas/MemberInvitation' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/members: description: The collection of Member operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' post: summary: Creates a consumer organization member description: 'Adds a member to a consumer org in a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url - consumer_org_url - user_registry_url' operationId: member_createConsumerOrgScope security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Member' examples: Member: summary: Example of member create at consumer-org scope. value: name: acme-member title: ACME Member summary: An example member create user: url: https://acme-apim.example.com/api/user-registries/acme-org/acme-user-registry1/users/acme-user role_urls: - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/roles/role2 application/yaml: schema: $ref: '#/components/schemas/Member' examples: Member: summary: Example of member create at consumer-org scope. value: name: acme-member title: ACME Member summary: An example member create user: url: https://acme-apim.example.com/api/user-registries/acme-org/acme-user-registry1/users/acme-user role_urls: - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/roles/role2 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Member' application/yaml: schema: $ref: '#/components/schemas/Member' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer organization members description: Returns the list of members of a consumer organization in a catalog. operationId: member_listConsumerOrgScope security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberList' application/yaml: schema: $ref: '#/components/schemas/MemberList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears consumer organization members description: Removes all members from a consumer org in a catalog. operationId: member_clearConsumerOrgScope security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}: description: Member object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/member' get: summary: Returns a consumer organization member description: Returns a member of a consumer organization in a catalog. operationId: member_getConsumerOrgScope security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Member' application/yaml: schema: $ref: '#/components/schemas/Member' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer organization member description: 'Updates a member of a consumer organization in a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url - consumer_org_url - user_registry_url' operationId: member_updateConsumerOrgScope security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Member' examples: Member: summary: Example of member update at consumer-org scope. value: title: Updated ACME Member summary: An example member update role_urls: - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/roles/role1 application/yaml: schema: $ref: '#/components/schemas/Member' examples: Member: summary: Example of member update at consumer-org scope. value: title: Updated ACME Member summary: An example member update role_urls: - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-consumer-org/roles/role1 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Member' application/yaml: schema: $ref: '#/components/schemas/Member' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer organization member description: Removes a member from a consumer organization in a catalog. operationId: member_delConsumerOrgScope security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Member' application/yaml: schema: $ref: '#/components/schemas/Member' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members: description: The collection of Member operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' post: summary: Creates a consumer organization member description: 'Adds a member to a consumer organization in a catalog, as accessed through a space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url - consumer_org_url - user_registry_url' operationId: member_createConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Member' examples: Member: summary: Example of member create at consumer-org(space-initiated) scope. value: name: acme-member title: ACME Member summary: An example member create user: url: https://acme-apim.example.com/api/user-registries/acme-org/acme-user-registry1/users/acme-user role_urls: - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-space/acme-consumer-org/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-space/acme-consumer-org/roles/role1 application/yaml: schema: $ref: '#/components/schemas/Member' examples: Member: summary: Example of member create at consumer-org(space-initiated) scope. value: name: acme-member title: ACME Member summary: An example member create user: url: https://acme-apim.example.com/api/user-registries/acme-org/acme-user-registry1/users/acme-user role_urls: - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-space/acme-consumer-org/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-space/acme-consumer-org/roles/role1 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Member' application/yaml: schema: $ref: '#/components/schemas/Member' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer organization members description: Returns the list of members of a consumer organization in a catalog, as accessed through a space. operationId: member_listConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MemberList' application/yaml: schema: $ref: '#/components/schemas/MemberList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears consumer organization members description: Removes all members from a consumer org in a catalog, as accessed through a space. operationId: member_clearConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:manage parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}: description: Member object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/member' get: summary: Returns a consumer organization member description: Returns a member of a consumer organization in a catalog, as accessed through a space. operationId: member_getConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:view parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Member' application/yaml: schema: $ref: '#/components/schemas/Member' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer organization member description: 'Updates a member of a consumer organization in a catalog, as accessed through a space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - space_url - consumer_org_url - user_registry_url' operationId: member_updateConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/Member' examples: Member: summary: Example of member update at consumer-org(space-initiated). value: title: Updated ACME Member summary: An example member update role_urls: - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-space/acme-consumer-org/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-space/acme-consumer-org/roles/role1 application/yaml: schema: $ref: '#/components/schemas/Member' examples: Member: summary: Example of member update at consumer-org(space-initiated). value: title: Updated ACME Member summary: An example member update role_urls: - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-space/acme-consumer-org/roles/role1 - https://acme-apim.example.com/api/consumer-orgs/acme-org/acme-catalog/acme-space/acme-consumer-org/roles/role1 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Member' application/yaml: schema: $ref: '#/components/schemas/Member' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer organization member description: Removes a member from a consumer organization in a catalog, as accessed through a space. operationId: member_delConsumerOrgScopeSpaceInitiated security: - oauth: - consumer-org:manage responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Member' application/yaml: schema: $ref: '#/components/schemas/Member' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{consumer-org}/apps: description: The collection of Application operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' post: summary: Creates a consumer app description: 'Creates a new app belonging to the given consumer org in a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url' operationId: app_create security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/App' examples: App: summary: Example of app create. value: name: acme-app title: ACME App summary: An example app create application/yaml: schema: $ref: '#/components/schemas/App' examples: App: summary: Example of app create. value: name: acme-app title: ACME App summary: An example app create responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer apps description: Returns the list of apps belonging to the given consumer org in a catalog. operationId: app_list security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AppList' application/yaml: schema: $ref: '#/components/schemas/AppList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears apps from a consumer org description: Deletes all apps from the given consumer org in a catalog. operationId: app_clear security: - oauth: - app:manage:all parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{consumer-org}/{app}: description: Application object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' get: summary: Returns a consumer app description: Returns the app with the given name or id belonging to the given consumer org in a catalog. operationId: app_get security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer app description: 'Updates the given app belonging to a consumer org in a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url' operationId: app_update security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/App' examples: App: summary: Example of app update with state enabled. value: title: Updated ACME App summary: An example app update state: enabled application/yaml: schema: $ref: '#/components/schemas/App' examples: App: summary: Example of app update with state enabled. value: title: Updated ACME App summary: An example app update state: enabled responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer app description: Deletes the app with the given name or id from a consumer org in a catalog. operationId: app_del security: - oauth: - app:manage:all responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps: description: The collection of Application operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' post: summary: Creates a consumer app description: 'Creates a new app belonging to the given consumer org in a catalog, as accessed through the given space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url' operationId: app_createSpaceInitiated security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists consumer apps description: Returns a list of apps belonging to the given consumer org in a catalog, as accessed through the given space. operationId: app_listSpaceInitiated security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AppList' application/yaml: schema: $ref: '#/components/schemas/AppList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears apps from a consumer org description: Deletes all apps from the given consumer org in a catalog, as accessed through the given space. operationId: app_clearSpaceInitiated security: - oauth: - app:manage:all parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}: description: Application object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' get: summary: Returns a consumer app description: Returns the app with the given name or id belonging to the given consumer org in a catalog, as accessed through the given space. operationId: app_getSpaceInitiated security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a consumer app description: 'Updates the given app belonging to a consumer org in a catalog, as accessed through the given space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url' operationId: app_updateSpaceInitiated security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a consumer app description: Deletes the app with the given name or id from a consumer org in a catalog, as accessed through the given space. operationId: app_delSpaceInitiated security: - oauth: - app:manage:all responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/App' application/yaml: schema: $ref: '#/components/schemas/App' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/strategies: description: The collection of Application Strategy Management operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' post: summary: Create a Application Strategy Management object description: 'Create a Application Strategy Management object Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: strategy_createConsumerOrgScopeSpaceInitiated security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Strategy' examples: Strategy: summary: Example for strategy create value: name: acme-strategy title: ACME Strategy application/yaml: schema: $ref: '#/components/schemas/Strategy' examples: Strategy: summary: Example for strategy create value: name: acme-strategy title: ACME Strategy responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Strategy' application/yaml: schema: $ref: '#/components/schemas/Strategy' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: List the Application Strategy Management objects operationId: strategy_listConsumerOrgScopeSpaceInitiated security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StrategyList' application/yaml: schema: $ref: '#/components/schemas/StrategyList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clear the Application Strategy Management objects operationId: strategy_clearConsumerOrgScopeSpaceInitiated security: - oauth: - app:manage:all parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/strategies/{strategy}: description: Application Strategy Management object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/strategy' get: summary: Get the Application Strategy Management object by name or id operationId: strategy_getConsumerOrgScopeSpaceInitiated security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Strategy' application/yaml: schema: $ref: '#/components/schemas/Strategy' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Update the Application Strategy Management object by name or id description: 'Update the Application Strategy Management object by name or id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: strategy_updateConsumerOrgScopeSpaceInitiated security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Strategy' examples: Strategy: summary: Example for strategy update value: title: Acme Strategy summary: Example for acme strategy update strategy_type: oauth2 dcr_config: application_type: public allowed_grant_types: - refresh_token auth_server_alias: mobile-auth-server application/yaml: schema: $ref: '#/components/schemas/Strategy' examples: Strategy: summary: Example for strategy update value: title: Acme Strategy summary: Example for acme strategy update strategy_type: oauth2 dcr_config: application_type: public allowed_grant_types: - refresh_token auth_server_alias: mobile-auth-server responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Strategy' application/yaml: schema: $ref: '#/components/schemas/Strategy' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Delete the Application Strategy Management object by name or id operationId: strategy_delConsumerOrgScopeSpaceInitiated security: - oauth: - app:manage:all responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Strategy' application/yaml: schema: $ref: '#/components/schemas/Strategy' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{consumer-org}/{app}/credentials: description: The collection of Application Credential operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' post: summary: Creates app credentials description: 'Adds a new set of credentials to an app in a catalog. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: credential_create security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of credential creation at catalog scope. value: name: acme-credential title: Acme credential creation client_id: acme client_secret: acme123 application/yaml: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of credential creation at catalog scope. value: name: acme-credential title: Acme credential creation client_id: acme client_secret: acme123 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists app credentials description: Returns the list of credentials for an app in a catalog. operationId: credential_list security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CredentialList' application/yaml: schema: $ref: '#/components/schemas/CredentialList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}: description: Application Credential object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/credential' get: summary: Returns app credentials description: Returns the given set of credentials for an app in a catalog. operationId: credential_get security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates credentials for an app description: 'Updates the given set of credentials for an app in a catalog. Fields not allowed to be null: - client_id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: credential_update security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of credential update at catalog scope. value: title: Acme credential update summary: An example credential update client_id: acme client_secret: acme1234 application/yaml: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of credential update at catalog scope. value: title: Acme credential update summary: An example credential update client_id: acme client_secret: acme1234 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes app credentials description: Removes the given set of credentials from an app in a catalog. operationId: credential_del security: - oauth: - app:manage:all responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/credential' post: summary: Reset the client id and client secret operationId: credential_reset security: - oauth: - app:manage:all responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/credential' post: summary: Reset the client secret operationId: credential_resetClientSecret security: - oauth: - app:manage:all responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/credential' post: summary: Verify the client secret operationId: credential_verifyClientSecret security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of verifying client secret at catalog scope. value: client_id: a5b88b99c71e14b5edd8916d2158bcef client_secret: bfc79dd07d173d1484b9aca5ed76d993 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials: description: The collection of Application Credential operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' post: summary: Creates app credentials description: 'Adds a new set of credentials to an app in a catalog, as accessed through a space. Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: credential_createSpaceInitiated security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of credential creation at space scope. value: name: acme-credential title: Acme credential creation client_id: acme client_secret: acme123 application/yaml: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of credential creation at space scope. value: name: acme-credential title: Acme credential creation client_id: acme client_secret: acme123 responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists app credentials description: Returns the list of credentials for an app in a catalog, as accessed through a space. operationId: credential_listSpaceInitiated security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CredentialList' application/yaml: schema: $ref: '#/components/schemas/CredentialList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears app credentials description: Removes all credentials for an app in a catalog, as accessed through a space. operationId: credential_clearSpaceInitiated security: - oauth: - app:manage:all parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}: description: Application Credential object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/credential' get: summary: Returns app credentials description: Returns the given set of credentials for an app in a catalog, as accessed through a space. operationId: credential_getSpaceInitiated security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates credentials for an app description: 'Updates the given set of credentials for an app in a catalog, as accessed through a space. Fields not allowed to be null: - client_id Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: credential_updateSpaceInitiated security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of credential update at space scope. value: title: Acme credential update summary: An example credential update client_id: acme client_secret: acme1234 application/yaml: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of credential update at space scope. value: title: Acme credential update summary: An example credential update client_id: acme client_secret: acme1234 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes app credentials description: Removes the given set of credentials from an app in a catalog, as accessed through a space. operationId: credential_delSpaceInitiated security: - oauth: - app:manage:all responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/credential' post: summary: Reset the client id and client secret operationId: credential_resetSpaceInitiated security: - oauth: - app:manage:all responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/credential' post: summary: Reset the client secret operationId: credential_resetClientSecretSpaceInitiated security: - oauth: - app:manage:all responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/credential' post: summary: Verify the client secret operationId: credential_verifyClientSecretSpaceInitiated security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' examples: Credential: summary: Example of verifying client secret at space scope. value: client_id: a5b88b99c71e14b5edd8916d2158bcef client_secret: bfc79dd07d173d1484b9aca5ed76d993 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Credential' application/yaml: schema: $ref: '#/components/schemas/Credential' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions: description: The collection of Subscription operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' post: summary: Creates a subscription description: 'Create a subscription for an app belonging to a connsumer organization in a catalog. Required fields: - plan Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: subscription_create security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Subscription' examples: Subscription: summary: Example of subscription create. value: name: acme-subscription title: ACME Subscription summary: An example subscription create plan: acme-plan product_url: https://acme-apim.example.com/api/catalogs/acme-org/acme-catalog/products/acme-product application/yaml: schema: $ref: '#/components/schemas/Subscription' examples: Subscription: summary: Example of subscription create. value: name: acme-subscription title: ACME Subscription summary: An example subscription create plan: acme-plan product_url: https://acme-apim.example.com/api/catalogs/acme-org/acme-catalog/products/acme-product responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Subscription' application/yaml: schema: $ref: '#/components/schemas/Subscription' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists subscriptions description: Returns the list of subscriptions for an app belonging to a connsumer organization in a catalog. operationId: subscription_list security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/product_url' - $ref: '#/components/parameters/mcp_server_url' - $ref: '#/components/parameters/plan_query' - $ref: '#/components/parameters/mcp_server_subscriptions' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SubscriptionList' application/yaml: schema: $ref: '#/components/schemas/SubscriptionList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears subscriptions description: Deletes all subscriptions for an app belonging to a connsumer organization in a catalog. operationId: subscription_clear security: - oauth: - app:manage:all parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}: description: Subscription object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/subscription' get: summary: Returns a subscription description: Returns a subscription for an app belonging to a connsumer organization in a catalog. operationId: subscription_get security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Subscription' application/yaml: schema: $ref: '#/components/schemas/Subscription' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a subscription description: 'Updates a subscription for an app belonging to a connsumer organization in a catalog. Fields not allowed: - billing_identifiers - plan_title Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: subscription_update security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Subscription' examples: Subscription: summary: Example of subscription update with state enabled. value: title: ACME Subscription summary: An example subscription update state: enabled application/yaml: schema: $ref: '#/components/schemas/Subscription' examples: Subscription: summary: Example of subscription update with state enabled. value: title: ACME Subscription summary: An example subscription update state: enabled responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Subscription' application/yaml: schema: $ref: '#/components/schemas/Subscription' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a subscription description: Deletes a subscriptions for an app belonging to a connsumer organization in a catalog. operationId: subscription_del security: - oauth: - app:manage:all responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Subscription' application/yaml: schema: $ref: '#/components/schemas/Subscription' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions: description: The collection of Subscription operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' post: summary: Creates a subscription description: 'Create a subscriptions for an app belonging to a connsumer organization in a catalog, as accessed through a space. Required fields: - plan Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: subscription_createSpaceInitiated security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Subscription' examples: Subscription: summary: Example of subscription create. value: name: acme-subscription title: ACME Subscription summary: An example subscription create plan: acme-plan product_url: https://acme-apim.example.com/api/spaces/acme-org/acme-catalog/acme-space/products/acme-product application/yaml: schema: $ref: '#/components/schemas/Subscription' examples: Subscription: summary: Example of subscription create. value: name: acme-subscription title: ACME Subscription summary: An example subscription create plan: acme-plan product_url: https://acme-apim.example.com/api/spaces/acme-org/acme-catalog/acme-space/products/acme-product responses: '201': description: Successful create content: application/json: schema: $ref: '#/components/schemas/Subscription' application/yaml: schema: $ref: '#/components/schemas/Subscription' '302': description: Redirect response headers: Location: description: Redirect payload schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management get: summary: Lists subscriptions description: Returns the list of subscriptions for an app belonging to a connsumer organization in a catalog, as accessed through a space. operationId: subscription_listSpaceInitiated security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/product_url' - $ref: '#/components/parameters/mcp_server_url' - $ref: '#/components/parameters/plan_query' - $ref: '#/components/parameters/mcp_server_subscriptions' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SubscriptionList' application/yaml: schema: $ref: '#/components/schemas/SubscriptionList' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Clears subscriptions description: Deletes all subscriptions for an app belonging to a connsumer organization in a catalog, as accessed through a space. operationId: subscription_clearSpaceInitiated security: - oauth: - app:manage:all parameters: - $ref: '#/components/parameters/confirm' responses: '204': description: Success 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}: description: Subscription object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org' - $ref: '#/components/parameters/app' - $ref: '#/components/parameters/subscription' get: summary: Returns a subscription description: Returns a subscription for an app belonging to a connsumer organization in a catalog, as accessed through a space. operationId: subscription_getSpaceInitiated security: - oauth: - app:view:all parameters: - $ref: '#/components/parameters/fields_2' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Subscription' application/yaml: schema: $ref: '#/components/schemas/Subscription' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management patch: summary: Updates a subscription description: 'Updates a subscription for an app belonging to a connsumer organization in a catalog, as accessed through a space. Fields not allowed: - billing_identifiers - plan_title Fields allowed but ignored: - id - type - api_version - scope - created_at - updated_at - url - org_url - catalog_url - consumer_org_url - app_url' operationId: subscription_updateSpaceInitiated security: - oauth: - app:manage:all requestBody: content: application/json: schema: $ref: '#/components/schemas/Subscription' examples: Subscription: summary: Example of subscription update with state enabled. value: title: ACME Subscription summary: An example subscription update state: enabled application/yaml: schema: $ref: '#/components/schemas/Subscription' examples: Subscription: summary: Example of subscription update with state enabled. value: title: ACME Subscription summary: An example subscription update state: enabled responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Subscription' application/yaml: schema: $ref: '#/components/schemas/Subscription' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management delete: summary: Deletes a subscription description: Deletes a subscriptions for an app belonging to a connsumer organization in a catalog, as accessed through a space. operationId: subscription_delSpaceInitiated security: - oauth: - app:manage:all responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/Subscription' application/yaml: schema: $ref: '#/components/schemas/Subscription' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Consumer Management servers: - url: '' description: APIM base path components: schemas: 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 Group: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - group 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 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 MemberList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Member' ConsumerOrg: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - consumer_org api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 state: type: string enum: - enabled - disabled owner_url: type: string format: uri org_url: type: string format: uri catalog_url: type: string format: uri group_urls: type: array items: type: string format: uri subscription_urls: type: array items: type: string format: uri owner: $ref: '#/components/schemas/User' members: type: array items: $ref: '#/components/schemas/Member' roles: type: array items: $ref: '#/components/schemas/Role' 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 ClientRegistration: description: Shows the configurations set for the oauth client, when using Dynamic Client Registration. This is a read only model. To update the configuration use the DynamicClientRegistrationConfig model. type: object additionalProperties: false properties: approval_pgfilename: type: string description: Approval page file name approval_pgfooter: type: string description: Approval page footer approval_pgheading: type: string description: Approval page heading approval_pglogo_filename: type: string description: Approval page logo filename approval_pgtitle: type: string description: Approval page title authcode_allowed: type: boolean description: Option to choose Authorization code grant type cl_scopes: type: array description: The scopes associated with this client items: type: string client_credentials_allowed: type: boolean description: Option to choose Client Credentials grant type client_id: type: string description: The client id client_secret: type: string enabled: type: boolean description: Is the client enabled? implicit_allowed: type: boolean description: Option to choose Implicit grant type name: type: string description: The client name notes: type: string description: Notes on the client pkce_type: type: string description: OAuth client level options to apply PKCE security, for the public clients using authorization code grant type. Applicable only for local auth server. enum: - not-enforced - enforced - use-global-setting primary_node: $ref: '#/components/schemas/Node' redirect_uris: type: array description: List of redirect urls allowed for this client items: type: string resource_owner_allowed: type: boolean description: Option to choose Resource Owner grant type shell: type: boolean token_lifetime: type: integer minimum: 0 maximum: 2147483647 description: Token life time token_refresh_limit: type: integer minimum: 0 maximum: 2147483647 description: The number of times token can be refreshed type: type: string description: specifies whether the client is either public or confidential client version: type: string description: The client version OAuth2Token: type: object additionalProperties: false properties: client_id: type: string description: unique identifier of the oauth2 client clientName: type: string description: the name of the client clientSecret: type: string description: the client secret expirationInterval: type: string description: the expiration interval redirectUris: type: array description: list of redirect uris items: type: string refreshCount: type: string description: number of times an access token can be refreshed scopes: type: array description: the scopes associated with the client items: type: string type: type: string description: type of the oauth2 client InvitationList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Invitation' Regenerate: type: object additionalProperties: false properties: notify: type: boolean Strategy: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - strategy 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 description: type: string strategy_type: type: string enum: - jwt-hsa - jwt-rsa - openid-connect-hsa - openid-connect-rsa - oauth2 - oauth2-local-hsa - oauth2-local-rsa - composite auth_server_alias: type: string client_id: type: string audience: type: string dcr_config: $ref: '#/components/schemas/DynamicClientRegistrationConfig' client_registration: $ref: '#/components/schemas/ClientRegistration' secret: type: string format: password gateway_secret: $ref: '#/components/schemas/GatewaySecret' primary_node: $ref: '#/components/schemas/Node' access_token_uris: type: array items: type: string authorization_uris: type: array items: type: string refresh_token_uris: type: array items: type: string jwt_access_token_uris: type: array items: type: string org_url: type: string format: uri catalog_url: type: string format: uri consumer_org_url: type: string format: uri app_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 App: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - app api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 state: type: string enum: - enabled - disabled - pending lifecycle_state: type: string enum: - development - production lifecycle_state_pending: type: - string - 'null' enum: - production app_credential_urls: type: array items: type: string format: uri client_id: type: string client_secret: type: string redirect_endpoints: type: array items: type: string format: uri application_public_certificate_entry: type: string org_url: type: string format: uri catalog_url: type: string format: uri consumer_org_url: type: string format: uri task_urls: type: array items: type: string format: uri image_endpoint: type: - string - 'null' format: uri application_type_url: type: string format: uri api_urls: type: - array - 'null' items: type: string format: uri consumer_org: type: object additionalProperties: false properties: id: type: string title: type: string name: type: string url: type: string format: uri credentials: type: array items: type: object additionalProperties: false properties: id: type: string client_id: type: string title: type: string name: type: string url: type: string format: uri access_tokens: $ref: '#/components/schemas/ApplicationToken' auth_strategy_urls: type: array description: Contains a list of JWT/Oauth/OpenID authentication strategies items: type: string format: uri contact_emails: type: array description: list of email contacts items: type: string custom_fields: type: object description: list of all custom fields additionalProperties: true icon_byte_array: type: string description: application icon byte array identifiers: type: array description: list of all application identifiers items: $ref: '#/components/schemas/ApplicationIdentifier' js_origins: type: array description: list of all javascript origins items: type: string primary_node: $ref: '#/components/schemas/Node' shell: type: boolean site_urls: type: array description: list of all site URLs items: type: string subscription: type: boolean version: type: string team_urls: type: array items: type: string format: uri rate_limit_notification_settings: type: object additionalProperties: false properties: enabled: type: boolean thresholds: type: object properties: '70': type: boolean '80': type: boolean '95': type: boolean 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 AppList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/App' ConsumerOrgSetting: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - consumer_org_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 invitation_ttl: type: integer minimum: 0 maximum: 2147483647 configured_billing: type: object additionalProperties: type: object properties: default_payment_method_url: type: string format: uri billing_identifiers: type: object additionalProperties: true 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 Node: type: object additionalProperties: false properties: hostId: type: string replica: type: integer minimum: 0 maximum: 1000 User: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - user api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 state: type: string enum: - enabled - disabled identity_provider: type: string username: type: string password: type: string format: password force_password_change: type: boolean reject_tokens_issued_before: type: - string - 'null' format: date-time email: type: string first_name: type: string last_name: type: string photo: type: string last_login_at: type: string format: date-time member_urls: type: array items: type: string format: uri user_group_urls: type: array items: type: string format: uri team_urls: type: array items: type: string format: uri org_url: type: string format: uri user_registry_url: type: string format: uri hashed_password: type: string salt: type: string encrypted_data: type: string encrypted_data_hash: type: string studio: $ref: '#/components/schemas/Studio' 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 CredentialList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Credential' StrategyList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Strategy' MemberInvitationList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/MemberInvitation' MemberInvitation: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - member_invitation 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 notify: type: boolean activation_link: type: string email: type: string format: email org_type: type: string role_urls: type: array items: type: string format: uri expires_at: type: string format: date-time 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 TransferOwner: type: object additionalProperties: false properties: new_owner_associate_url: type: string format: uri new_owner_member_url: type: string format: uri new_owner_user_url: type: string format: uri old_owner_new_role_urls: type: array items: type: string format: uri DynamicClientRegistrationConfig: type: object description: Accepts the configurations to be set for the oauth client, when using Dynamic Client Registration properties: allowed_grant_types: type: array description: grant types to be allowed for this client items: type: string enum: - authorization_code - password - client_credentials - refresh_token - implicit application_type: type: string description: type of the application client_id: type: string description: The client id client_name: type: string description: The client name client_secret: type: string description: The client secret client_type: type: string description: specifies whether the client is either public or confidential client enum: - public - confidential client_version: type: string description: The client version expiration_interval: type: string description: Token expiry time pkce_type: type: string description: OAuth client level options to apply PKCE security, for the public clients using authorization code grant type. Applicable only for local auth server. enum: - not-enforced - enforced - use-global-setting redirect_uris: type: array description: The redirect uris items: type: string refresh_count: type: string description: The number of times token can be refreshed scopes: type: array description: The scopes associated with this client items: type: string Invitation: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - invitation 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 notify: type: boolean activation_link: type: string email: type: string format: email expires_at: type: string format: date-time org_url: type: string format: uri catalog_url: type: string format: uri space_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 APIAccessKey: type: object additionalProperties: false properties: apiAccessKey: type: string description: API access key expirationDate: type: string description: expiration date of the api key expirationInterval: type: string description: expiration interval of the api key Studio: type: object additionalProperties: false properties: vcs_config: type: object additionalProperties: false properties: server: type: string token: type: string repositories: type: array items: type: object additionalProperties: false properties: description: type: - string - 'null' name: type: string GroupList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Group_2' Member: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - member 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 state: type: string enum: - enabled - disabled user: $ref: '#/components/schemas/User' role_urls: type: array items: type: string format: uri inherited_role_urls: type: array items: type: string format: uri user_group_role_urls: type: array items: type: string format: uri default_user_group_url: type: string format: uri 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 PaymentMethod: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - payment_method api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 integration_url: type: string format: uri consumer_org_url: type: string format: uri billing_url: type: string format: uri configuration: type: object additionalProperties: type: string metadata: type: object additionalProperties: type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true url: type: string readOnly: true format: uri Subscription: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - subscription api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 state: type: string enum: - pending - enabled - rejected - disabled product_url: type: - string - 'null' format: uri mcp_server_url: type: - string - 'null' format: uri product: type: object additionalProperties: false properties: id: type: string title: type: string name: type: string version: type: string url: type: string format: uri plan: type: string plan_title: type: string task_urls: type: array items: type: string format: uri state_pending: type: - string - 'null' enum: - enabled org_url: type: string format: uri catalog_url: type: string format: uri consumer_org_url: type: string format: uri consumer_org: type: object additionalProperties: false properties: id: type: string title: type: string name: type: string url: type: string format: uri app_url: type: string format: uri app: type: object additionalProperties: false properties: id: type: string title: type: string name: type: string url: type: string format: uri credentials: type: array items: type: object additionalProperties: false properties: id: type: string client_id: type: string title: type: string name: type: string url: type: string format: uri billing_identifiers: description: non-sensitive identifiers of billing system resources type: object additionalProperties: true 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 Credential: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - credential 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 client_id: type: string client_secret_hashed: type: string client_secret: type: string org_url: type: string format: uri catalog_url: type: string format: uri consumer_org_url: type: string format: uri app_url: type: string format: uri state: type: string enum: - enabled - pending 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 SubscriptionList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Subscription' AssociateList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Associate' Role: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - role 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 permission_urls: type: array items: type: string format: uri inherited_permission_urls: type: array items: type: string format: uri member_urls: type: array items: type: string format: uri user_group_role_assignment_urls: type: array items: type: string format: uri external_group_mapping: type: - object - 'null' additionalProperties: false properties: user_registry_url: type: string format: uri ldap_groups: type: array items: type: string user_group_filter_prefix: type: string user_group_filter_suffix: 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 ConsumerOrgList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/ConsumerOrg' PaymentMethodList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/PaymentMethod' GatewaySecret: type: object additionalProperties: false properties: cached_secret: type: string secret: type: string xrayview: type: string RoleList: type: object additionalProperties: false properties: total_results: type: integer results: type: array items: $ref: '#/components/schemas/Role' ApplicationToken: type: object additionalProperties: false properties: api_access_key: $ref: '#/components/schemas/APIAccessKey' oauth2_token: $ref: '#/components/schemas/OAuth2Token' ApplicationIdentifier: type: object properties: id: type: string description: unique identifier of the application identifier key: type: string enum: - access_profile - api_key - http_basic_auth - http_headers - https_certificate - host_name_address - ip_address_range - jwt_claims - kerberos_token - oauth2_token - open_id_claims - partner_id - payload_element - token - wssec_username_token - wssec_x509_token - xpath_expression description: identifier type name: type: string description: name of the identifier value: type: array description: list of identifier values items: type: string Group_2: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - group api_version: type: string readOnly: true enum: - 2.0.0 id: type: string readOnly: true name: type: string maxLength: 255 title: type: string maxLength: 1023 summary: type: string maxLength: 65535 scope: type: string org_urls: type: array items: type: string format: uri gateway_service_urls: type: array items: type: string format: uri portal_service_urls: type: array items: type: string format: uri user_registry_urls: type: array items: type: string format: uri tls_client_profile_urls: type: array items: type: string format: uri oauth_provider_urls: type: array items: type: string format: uri jwt_provider_urls: type: array items: type: string format: uri billing_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 Associate: type: object additionalProperties: false properties: type: type: string readOnly: true enum: - associate 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 state: type: string user: $ref: '#/components/schemas/User' 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 parameters: fields: name: fields in: query description: field name required: false schema: type: string group: name: group in: path description: Group name or id required: true schema: type: string consumer-org: name: consumer-org in: path description: Consumer Organization name or id required: true schema: type: string limit: name: limit in: query description: Maximum number of items to return required: false schema: type: integer credential: name: credential in: path description: Application Credential name or id required: true schema: type: string fields_2: name: fields in: query description: List of field names to return required: false schema: type: string associate: name: associate in: path description: Associate name or id required: true schema: type: string org: name: org in: path description: Organization name or id required: true schema: type: string invitation: name: invitation in: path description: Consumer Organization Invitation name or id required: true schema: type: string delete_old_owner: name: delete_old_owner in: query description: Delete old owner required: false schema: type: boolean subscription: name: subscription in: path description: Subscription name or id required: true schema: type: string expand: name: expand in: query description: List of transient field to expand required: false schema: type: string mcp_server_url: name: mcp_server_url in: query description: MCP Server Url required: false schema: type: string strategy: name: strategy in: path description: Application Strategy Management 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 mcp_server_subscriptions: name: mcp_server_subscriptions in: query description: Only retrieve subscriptions for MCP Servers required: false schema: type: boolean space: name: space in: path description: Space name or id required: true schema: type: string app: name: app in: path description: Application name or id required: true schema: type: string payment-method: name: payment-method in: path description: Payment Method name or id required: true schema: type: string member-invitation: name: member-invitation in: path description: Member Invitation name or id required: true schema: type: string confirm: name: confirm in: query description: Confirmation for critical updates required: true schema: type: string role: name: role in: path description: Role name or id required: true schema: type: string catalog: name: catalog in: path description: Catalog name or id required: true schema: type: string cascade: name: cascade in: query description: Cascade the behavior required: false schema: type: boolean product_url: name: product_url in: query description: Product Url required: false schema: type: string plan_query: name: plan in: query description: Plan Name required: false schema: type: string member: name: member in: path description: Member 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: password: tokenUrl: /token refreshUrl: /token scopes: app:manage: 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 Application Credential object, Clear the Application Credential objects, 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: List the Application objects, Get the Application 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 my:manage: Update the Me object, Delete the Me object my:view: Get the Me object, List the My Permission objects, List the My Organization objects org:manage: Create a My Organization 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, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member 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 org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id authorizationCode: authorizationUrl: /oauth2/authorize tokenUrl: /token refreshUrl: /token scopes: app:manage: 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 Application Credential object, Clear the Application Credential objects, 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: List the Application objects, Get the Application 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 my:manage: Update the Me object, Delete the Me object my:view: Get the Me object, List the My Permission objects, List the My Organization objects org:manage: Create a My Organization 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, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member 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 org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id x-refined-from: - ibm-api-connect-consumer-api-openapi.yml - ibm-api-connect-management-api-openapi.yml x-ibm-configuration: testable: false