IBM API Connect

IBM API Connect Organization Management API

The Organization Management API from IBM API Connect — 40 operation(s) for organization management.

GitHub OpenAPI

Operations 67

GET /consumer/permissions List all Permission objects in all collections #
GET /consumer/permissions/org List the Permission objects #
GET /consumer/permissions/org/{permission} Get the Permission object by name or id #
GET /consumer/permissions/consumer List the Permission objects #
GET /consumer/permissions/consumer/{permission} Get the Permission object by name or id #
GET /orgs/{org} Get the Organization object by name or id #
PATCH /orgs/{org} Update the Organization object by name or id #
DELETE /orgs/{org} Delete the Organization object by name or id #
POST /orgs/{org}/transfer-owner Transfer owner to a new member #
POST /org-invitations/{invitation}/register Register using the Organization Invitation #
POST /org-invitations/{invitation}/accept Accept using the Organization Invitation #
POST /orgs/{org}/member-invitations Create a Member Invitation object #
GET /orgs/{org}/member-invitations List the Member Invitation objects #
DELETE /orgs/{org}/member-invitations Clear the Member Invitation objects #
GET /orgs/{org}/member-invitations/{member-invitation} Get the Member Invitation object by name or id #
DELETE /orgs/{org}/member-invitations/{member-invitation} Delete the Member Invitation object by name or id #
PATCH /orgs/{org}/member-invitations/{member-invitation} Updates a provider organization member invitation #
POST /orgs/{org}/member-invitations/{member-invitation}/regenerate Regenerate the Member Invitation #
POST /orgs/{org}/member-invitations/{member-invitation}/register Register using the Member Invitation #
POST /orgs/{org}/member-invitations/{member-invitation}/accept Accept using the Member Invitation #
GET /orgs/{org}/associates List the Associate objects #
GET /orgs/{org}/associates/{associate} Get the Associate object by name or id #
GET /orgs/{org}/members List the Member objects #
DELETE /orgs/{org}/members Clear the Member objects #
POST /orgs/{org}/members Creates a provider organization member #
GET /orgs/{org}/members/{member} Get the Member object by name or id #
PATCH /orgs/{org}/members/{member} Update the Member object by name or id #
DELETE /orgs/{org}/members/{member} Delete the Member object by name or id #
GET /orgs/{org}/roles List the Role objects #
POST /orgs/{org}/roles Creates a provider organization role #
DELETE /orgs/{org}/roles Clears provider organization roles #
GET /orgs/{org}/roles/{role} Get the Role object by name or id #
PATCH /orgs/{org}/roles/{role} Updates a provider organization role #
DELETE /orgs/{org}/roles/{role} Deletes a provider organization role #
POST /orgs/{org}/payment-methods Create a Payment Method object #
GET /orgs/{org}/payment-methods List the Payment Method objects #
GET /orgs/{org}/payment-methods/{payment-method} Get the Payment Method object by name or id #
PATCH /orgs/{org}/payment-methods/{payment-method} Update the Payment Method object by name or id #
DELETE /orgs/{org}/payment-methods/{payment-method} Delete the Payment Method object by name or id #
POST /orgs/{org}/search/user Search provider users from an organization #
POST /orgs/{org}/user-groups Create a User Group object #
GET /orgs/{org}/user-groups List the User Group objects #
DELETE /orgs/{org}/user-groups Clear the User Group objects #
GET /orgs/{org}/user-groups/{user-group} Get the User Group object by name or id #
PATCH /orgs/{org}/user-groups/{user-group} Update the User Group object by name or id #
DELETE /orgs/{org}/user-groups/{user-group} Delete the User Group object by name or id #
POST /orgs/{org}/user-group-role-assignments Create a User Group Role Assignment object #
GET /orgs/{org}/user-group-role-assignments List the User Group Role Assignment objects #
DELETE /orgs/{org}/user-group-role-assignments Clear the User Group Role Assignment objects #
GET /orgs/{org}/user-group-role-assignments/{user-group-role-assignment} Get the User Group Role Assignment object by name or id #
PATCH /orgs/{org}/user-group-role-assignments/{user-group-role-assignment} Update the User Group Role Assignment object by name or id #
DELETE /orgs/{org}/user-group-role-assignments/{user-group-role-assignment} Delete the User Group Role Assignment object by name or id #
GET /cloud/permissions Lists cloud-level permissions #
GET /cloud/permissions/org Lists cloud-level oorganization permissions #
GET /cloud/permissions/org/{permission} Returns an organization permission #
GET /cloud/permissions/provider Lists cloud-level provider permissions #
GET /cloud/permissions/provider/{permission} Returns a provider permission #
GET /cloud/permissions/consumer Lists cloud-level consumer permissions #
GET /cloud/permissions/consumer/{permission} Returns a consumer permission #
GET /cloud/permissions/deployment Lists cloud-level deployment permissions #
GET /cloud/permissions/deployment/{permission} Returns a deployment permission #
GET /catalogs/{org}/{catalog}/activations List the Activation objects #
DELETE /catalogs/{org}/{catalog}/activations Clear the Activation objects #
GET /activations/{org}/{catalog}/{activation} Get the Activation object by name or id #
DELETE /activations/{org}/{catalog}/{activation} Delete the Activation object by name or id #
GET /cloud/permissions/cloud Lists cloud-level cloud permissions #
GET /cloud/permissions/cloud/{permission} Returns a cloud permission #

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://artifacts.apis.io/ibm-api-connect/openapi/ibm-api-connect-organization-management-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-org-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-role-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-member-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-activation-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-member-invitation-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-user-group-schema.json

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-organization-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-organization-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ibm Api Connect Organization 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
  - x-refined-note differs across the merged source definitions and was not carried
  description: 'Operations tagged Organization Management across 3 of this provider''s published API definitions: ibm-api-connect-consumer-api-openapi.yml, ibm-api-connect-management-api-openapi.yml, ibm-api-connect-organization-management-api-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:


# --- truncated at 32 KB (123 KB total) ---
# Full source: https://artifacts.apis.io/ibm-api-connect/openapi/ibm-api-connect-organization-management-api-openapi.yml