IBM API Connect

IBM API Connect Consumer Management API

The Consumer Management API from IBM API Connect — 65 operation(s) for consumer management.

GitHub OpenAPI

Operations 150

GET /groups/{group} Get the Group object by name or id #
POST /catalogs/{org}/{catalog}/apps Create a Application object #
GET /catalogs/{org}/{catalog}/apps Lists consumer apps #
DELETE /catalogs/{org}/{catalog}/apps Clear the Application objects #
GET /catalogs/{org}/{catalog}/apps/{app} Get the Application object by name or id #
PATCH /catalogs/{org}/{catalog}/apps/{app} Update the Application object by name or id #
DELETE /catalogs/{org}/{catalog}/apps/{app} Delete the Application object by name or id #
POST /spaces/{org}/{catalog}/{space}/apps Create a Application object #
GET /spaces/{org}/{catalog}/{space}/apps Lists consumer apps #
DELETE /spaces/{org}/{catalog}/{space}/apps Clear the Application objects #
GET /spaces/{org}/{catalog}/{space}/apps/{app} Get the Application object by name or id #
PATCH /spaces/{org}/{catalog}/{space}/apps/{app} Update the Application object by name or id #
DELETE /spaces/{org}/{catalog}/{space}/apps/{app} Delete the Application object by name or id #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/settings Returns consumer organization settings #
PUT /consumer-orgs/{org}/{catalog}/{consumer-org}/settings Updates consumer organization settings #
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/settings Deletes consumer organization settings #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings Returns consumer organization settings #
PUT /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings Updates consumer organization settings #
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings Deletes consumer organization settings #
POST /catalogs/{org}/{catalog}/consumer-org-invitations Create a Consumer Organization Invitation object #
GET /catalogs/{org}/{catalog}/consumer-org-invitations Lists consumer organization invitations #
DELETE /catalogs/{org}/{catalog}/consumer-org-invitations Clears consumer organization invitations #
GET /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation} Returns a consumer organization invitation #
PATCH /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation} Updates a consumer organization invitation #
DELETE /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation} Deletes a consumer organization invitation #
POST /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}/regenerate Regenerate the Consumer Organization Invitation #
POST /spaces/{org}/{catalog}/{space}/consumer-org-invitations Creates a consumer organization invitation #
GET /spaces/{org}/{catalog}/{space}/consumer-org-invitations Lists consumer organization invitations #
DELETE /spaces/{org}/{catalog}/{space}/consumer-org-invitations Clears consumer organization invitations #
GET /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation} Returns a consumer organization invitation #
PATCH /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation} Updates a consumer organization invitation #
DELETE /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation} Deletes a consumer organization invitation #
POST /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}/regenerate Regenerate the Consumer Organization Invitation #
POST /catalogs/{org}/{catalog}/consumer-orgs Creates a consumer organization #
GET /catalogs/{org}/{catalog}/consumer-orgs Lists consumer organizations #
DELETE /catalogs/{org}/{catalog}/consumer-orgs Clears consumer organizations #
GET /consumer-orgs/{org}/{catalog}/{consumer-org} Returns a consumer organization #
PATCH /consumer-orgs/{org}/{catalog}/{consumer-org} Updates a consumer organization #
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org} Deletes a consumer organization #
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/transfer-owner Transfer owner to an associate #
POST /spaces/{org}/{catalog}/{space}/consumer-orgs Creates a consumer organization #
GET /spaces/{org}/{catalog}/{space}/consumer-orgs Lists consumer organizations #
DELETE /spaces/{org}/{catalog}/{space}/consumer-orgs Clears consumer organizations #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org} Returns a consumer organization #
PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org} Updates a consumer organization #
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org} Deletes a consumer organization #
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/transfer-owner Transfer owner to an associate #
POST /catalogs/{org}/{catalog}/consumer-groups Creates a consumer group #
GET /catalogs/{org}/{catalog}/consumer-groups Lists consumer groups #
DELETE /catalogs/{org}/{catalog}/consumer-groups Clears consumer groups #
GET /catalogs/{org}/{catalog}/consumer-groups/{group} Returns a consumer group #
PATCH /catalogs/{org}/{catalog}/consumer-groups/{group} Updates a consumer group #
DELETE /catalogs/{org}/{catalog}/consumer-groups/{group} Deletes a consumer group #
POST /spaces/{org}/{catalog}/{space}/consumer-groups Create a Group object #
GET /spaces/{org}/{catalog}/{space}/consumer-groups List the Group objects #
DELETE /spaces/{org}/{catalog}/{space}/consumer-groups Clear the Group objects #
GET /spaces/{org}/{catalog}/{space}/consumer-groups/{group} Get the Group object by name or id #
PATCH /spaces/{org}/{catalog}/{space}/consumer-groups/{group} Update the Group object by name or id #
DELETE /spaces/{org}/{catalog}/{space}/consumer-groups/{group} Delete the Group object by name or id #
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods Create a Payment Method object #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods List the Payment Method objects #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method} Get the Payment Method object by name or id #
PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method} Update the Payment Method object by name or id #
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method} Delete the Payment Method object by name or id #
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/payment-methods Create a Payment Method object #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/payment-methods List the Payment Method objects #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/payment-methods/{payment-method} Get the Payment Method object by name or id #
PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/payment-methods/{payment-method} Update the Payment Method object by name or id #
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/payment-methods/{payment-method} Delete the Payment Method object by name or id #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/roles Lists consumer organization roles #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role} Returns a consumer organization role #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles Lists consumer organization roles #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role} Returns a consumer organization role #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/associates Lists associates #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/associates/{associate} Returns an associate #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates Lists associates #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates/{associate} Returns an associate #
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations Creates a consummer organization member invitation #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations Lists consumer organization member invitations #
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations Clears consumer organization member invitations #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation} Returns a consumer organization member invitation #
PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation} Updates a consumer organization member invitation #
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation} Creates a consumer organization member invitation #
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}/regenerate Regenerate the Member Invitation #
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations Creates a consummer organization member invitation #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations Lists consumer organization member invitations #
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations Clears consumer organization member invitations #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation} Returns a consumer organization member invitation #
PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation} Updates a consumer organization member invitation #
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation} Deletes a consumer organization member invitation #
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}/regenerate Regenerate the Member Invitation #
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/members Creates a consumer organization member #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/members Lists consumer organization members #
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/members Clears consumer organization members #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member} Returns a consumer organization member #
PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member} Updates a consumer organization member #
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member} Deletes a consumer organization member #
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members Creates a consumer organization member #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members Lists consumer organization members #
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members Clears consumer organization members #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member} Returns a consumer organization member #
PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member} Updates a consumer organization member #
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member} Deletes a consumer organization member #
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/apps Creates a consumer app #
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/apps Lists consumer apps #
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/apps Clears apps from a consumer org #
GET /apps/{org}/{catalog}/{consumer-org}/{app} Returns a consumer app #
PATCH /apps/{org}/{catalog}/{consumer-org}/{app} Updates a consumer app #
DELETE /apps/{org}/{catalog}/{consumer-org}/{app} Deletes a consumer app #
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps Creates a consumer app #
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps Lists consumer apps #
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps Clears apps from a consumer org #
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app} Returns a consumer app #
PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app} Updates a consumer app #
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app} Deletes a consumer app #
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/strategies Create a Application Strategy Management object #
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/strategies List the Application Strategy Management objects #
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/strategies Clear the Application Strategy Management objects #
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/strategies/{strategy} Get the Application Strategy Management object by name or id #
PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/strategies/{strategy} Update the Application Strategy Management object by name or id #
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/strategies/{strategy} Delete the Application Strategy Management object by name or id #
POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials Creates app credentials #
GET /apps/{org}/{catalog}/{consumer-org}/{app}/credentials Lists app credentials #
GET /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential} Returns app credentials #
PATCH /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential} Updates credentials for an app #
DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential} Deletes app credentials #
POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset Reset the client id and client secret #
POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret Reset the client secret #
POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret Verify the client secret #
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials Creates app credentials #
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials Lists app credentials #
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials Clears app credentials #
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential} Returns app credentials #
PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential} Updates credentials for an app #
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential} Deletes app credentials #
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset Reset the client id and client secret #
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret Reset the client secret #
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret Verify the client secret #
POST /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions Creates a subscription #
GET /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions Lists subscriptions #
DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions Clears subscriptions #
GET /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription} Returns a subscription #
PATCH /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription} Updates a subscription #
DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription} Deletes a subscription #
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions Creates a subscription #
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions Lists subscriptions #
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions Clears subscriptions #
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription} Returns a subscription #
PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription} Updates a subscription #
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription} Deletes a subscription #

Documentation

📖
Documentation
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
GettingStarted
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
Authentication
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cli-managing-platform-rest-api-keys

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ibm-api-connect/refs/heads/main/openapi/ibm-api-connect-consumer-management-api-openapi.yml

Other Resources

🔗
Reference
https://apic-api.apiconnect.ibmcloud.com/v12/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ibm-api-connect:ibm-api-connect-consumer-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ibm-api-connect-consumer-management-api-openapi.yml Raw ↑ 
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:


# --- truncated at 32 KB (240 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ibm-api-connect/refs/heads/main/openapi/ibm-api-connect-consumer-management-api-openapi.yml