# API Experience Hub Management API

Administer API Experience Hub portals, members and the assets they expose.

Use this API as a portal owner to provision and operate Salesforce-hosted developer
portals that surface APIs from Anypoint ...

- **Version:** 1.0.0
- **Category:** Platform
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/api-experience-hub-management/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/api-experience-hub` — US
- `https://eu1.anypoint.mulesoft.com/api-experience-hub` — EU
- `https://ca1.platform.mulesoft.com/api-experience-hub` — CA
- `https://jp1.platform.mulesoft.com/api-experience-hub` — JP

## Operations (25)
### GET /api/v1/connections/{connectionId}/apiPortals

**Operation ID:** `getAllApiPortalByConnectionId`
List portals for connection
Returns all portals associated with a specific connection.

**Parameters:**
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### PUT /api/v1/connections/{connectionId}/apiPortals/{portalId}/users/{targetUserId}/userGroups

**Operation ID:** `addGroupMappingToUser`
Assign user groups to user
Applies the specified user group memberships to a portal user.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `targetUserId` | query | Unique identifier of the target portal user | required |

### GET /api/v1/connections

**Operation ID:** `getConnections`
List connections
Returns all connections for the current organization.

### GET /api/v1/connections/{connectionId}/apiPortals/{portalId}/userGroups

**Operation ID:** `getAllProfilesByPortal`
List profiles and user groups
Returns all profiles and user groups for a portal.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### POST /api/v1/connections/{connectionId}/apiPortals/{portalId}/userGroups

**Operation ID:** `createUserGroup`
Create a user group
Creates a new user group within the portal.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### GET /api/v1/connections/{connectionId}/apiPortals/{portalId}/userGroups/{userGroupId}/groupMappings

**Operation ID:** `getGroupMappings`
List group mappings
Returns all team group mappings for a specific user group.

**Parameters:**
| `userGroupId` | query | Unique identifier of the user group | required |
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### POST /api/v1/connections/{connectionId}/apiPortals/{portalId}/userGroups/{userGroupId}/groupMappings

**Operation ID:** `addAdditionalGroupMapping`
Add group mapping
Adds an identity provider group mapping to a user group.

**Parameters:**
| `userGroupId` | query | Unique identifier of the user group | required |
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### POST /api/v1/connections/{connectionId}/apiPortals/{portalId}/assets

**Operation ID:** `addAssetsToCommunity`
Publish assets to portal
Adds one or more Exchange assets to the portal for consumer discovery.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### POST /api/v1/connections/{connectionId}/apiPortals/{portalId}/assets/search

**Operation ID:** `searchCommunityAssets`
Search published assets
Searches assets currently published in the portal.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `x-limit` | query | Maximum number of search results to return | optional |
| `x-from` | query | Offset for paginated search results | optional |

### POST /api/v1/connections/{connectionId}/apiPortals/{portalId}/assets/search/exchange

**Operation ID:** `searchExchangeAssets`
Search Exchange assets
Searches Anypoint Exchange for assets available to publish.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `x-limit` | query | Maximum number of search results to return | optional |
| `x-from` | query | Offset for paginated search results | optional |

### POST /api/v1/connections/{connectionId}/apiPortals/{portalId}/assets/remove

**Operation ID:** `removeAssetFromCommunity`
Remove assets from portal
Removes one or more assets from the portal.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### POST /api/v1/connections/{connectionId}/apiPortals/{portalId}/assets/exchange/search

**Operation ID:** `legacySearchExchangeAssets`
Search Exchange assets (legacy)
Legacy endpoint for searching Anypoint Exchange assets.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `x-limit` | query | Maximum number of search results to return | optional |
| `x-from` | query | Offset for paginated search results | optional |

### PATCH /api/v1/connections/{connectionId}/apiPortals/{portalId}/users/{targetUserId}/enable

**Operation ID:** `enableCommunityUser`
Enable a user
Enables a previously disabled portal user account.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `targetUserId` | query | Unique identifier of the target portal user | required |

### PATCH /api/v1/connections/{connectionId}/apiPortals/{portalId}/users/{targetUserId}/disable

**Operation ID:** `disableCommunityUser`
Disable a user
Disables a portal user account.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `targetUserId` | query | Unique identifier of the target portal user | required |

### PATCH /api/v1/connections/{connectionId}/apiPortals/{portalId}/userGroups/{userGroupId}

**Operation ID:** `updateUserGroup`
Update a user group
Updates the name and description of a user group.

**Parameters:**
| `userGroupId` | query | Unique identifier of the user group | required |
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### DELETE /api/v1/connections/{connectionId}/apiPortals/{portalId}/userGroups/{userGroupId}

**Operation ID:** `deleteUserGroup`
Delete a user group
Permanently deletes a user group from the portal.

**Parameters:**
| `userGroupId` | query | Unique identifier of the user group | required |
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### PATCH /api/v1/connections/{connectionId}/apiPortals/{portalId}/prospects/{prospectId}

**Operation ID:** `approveProspect`
Approve a prospect
Approves a pending prospect and creates their user account.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `prospectId` | query | Unique identifier of the prospect | required |

### DELETE /api/v1/connections/{connectionId}/apiPortals/{portalId}/prospects/{prospectId}

**Operation ID:** `rejectProspect`
Reject a prospect
Deletes a pending prospect registration request.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `prospectId` | query | Unique identifier of the prospect | required |

### GET /api/v1/connections/{connectionId}/apiPortals/{portalId}/assets/{groupId}/{assetId}

**Operation ID:** `getAllVersionsVisibilityByGA`
Get asset version visibility
Returns visibility settings for all minor versions of an asset.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `assetId` | query | Exchange asset ID | required |

### PATCH /api/v1/connections/{connectionId}/apiPortals/{portalId}/assets/{groupId}/{assetId}

**Operation ID:** `updateCommunityAsset`
Update asset visibility
Updates the visibility settings for an asset's minor versions and instances.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `assetId` | query | Exchange asset ID | required |

### GET /api/v1/connections/{connectionId}/apiPortals/{portalId}/users

**Operation ID:** `getCommunityUsers`
List users
Returns portal users with optional filtering by status and search term.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `searchTerm` | query | Text to search for in user names and emails | optional |
| `isActive` | query | Filter users by active status | optional |
| `x-limit` | query | Maximum number of users to return | optional |
| `x-offset` | query | Number of results to skip for pagination | optional |

### GET /api/v1/connections/{connectionId}/apiPortals/{portalId}/users/{userId}

**Operation ID:** `getCommunityUser`
Get user details
Returns detailed information about a specific portal user.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `userId` | query | Unique identifier of the portal user | required |

### GET /api/v1/connections/{connectionId}/apiPortals/{portalId}/prospects

**Operation ID:** `getProspects`
List prospects
Returns all prospects with optional search filtering.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `searchTerm` | query | Text to search for in prospect names and emails | optional |

### GET /api/v1/connections/{connectionId}/apiPortals/{portalId}/prospects/count

**Operation ID:** `getProspectCount`
Get prospect count
Returns the count of pending prospects for the portal.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |

### DELETE /api/v1/connections/{connectionId}/apiPortals/{portalId}/userGroups/{userGroupId}/groupMappings/{idpId}/{groupMappingName}

**Operation ID:** `deleteGroupMappings`
Delete group mapping
Removes an identity provider group mapping from a user group.

**Parameters:**
| `userGroupId` | query | Unique identifier of the user group | required |
| `portalId` | query | Unique identifier of the portal | required |
| `connectionId` | query | Unique identifier of the Salesforce connection | required |
| `idpId` | query | Identity provider ID | required |
| `groupMappingName` | query | Name of the group mapping to remove | required |


## Related Skills
- [curate-portal-assets](https://dev-portal.mulesoft.com/skills/curate-portal-assets.md) — Curate API assets in an API Experience Hub portal. Use when an admin needs to
publish Exchange assets to a portal, adjust which minor versions are visible
to consumers, or remove assets from a portal. Covers discovery of unpublished
assets, publishing, visibility configuration and removal.
- [manage-portal-members-and-prospects](https://dev-portal.mulesoft.com/skills/manage-portal-members-and-prospects.md) — Manage the lifecycle of API Experience Hub portal members and prospects.
Use when an admin needs to approve or reject prospects (candidate users),
list active members, inspect and update a member's user-group assignments,
or disable a member. Covers the full join → approve → assign → disable flow.
- [manage-portal-user-groups](https://dev-portal.mulesoft.com/skills/manage-portal-user-groups.md) — Manage the user groups that gate access to APIs and content inside an API
Experience Hub portal. Use when an admin needs to list, create, update, or
delete user groups, or to manage group mappings (links between external
identity-provider groups and AEH user groups). These groups are the unit
used for per-version asset visibility and member assignments.