| name | manage-portal-members-and-prospects |
| description | 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 Members and Prospects
Overview
Handles the membership lifecycle of an API Experience Hub (AEH) portal. Prospects are users who have requested access but are not yet portal members; members are active users with assigned user groups. This workflow lets portal administrators approve or reject prospects, audit the member list, adjust user-group assignments per member, and disable members who should no longer have access.
What you'll build: A governed portal membership list with the right people assigned to the right user groups.
Prerequisites
Before starting, ensure:
-
Authentication ready
- Valid Bearer token for Anypoint Platform
- AEH Administrator or AEH Portal Administrator permissions
-
Environment already bootstrapped
- Connection and portal exist (use the AEH UI if not)
- At least one user group exists in the portal (see
manage-portal-user-groups)
Step 1: List AEH Connections
Retrieve the AEH connections the user has access to.
What you'll need:
Action: List connections and pick the one hosting the target portal.
api: urn:api:api-experience-hub-management
operationId: getConnections
inputs: {}
outputs:
- name: connectionId
path: $[*].id
labels: $[*].name
description: AEH connection ID (Salesforce org link) backing the portal
What happens next: The chosen connectionId scopes every subsequent call.
Step 2: List Portals on the Connection
Pick the target portal whose membership you want to manage.
What you'll need:
api: urn:api:api-experience-hub-management
operationId: getAllApiPortalByConnectionId
inputs:
connectionId:
from:
variable: connectionId
description: Connection ID from Step 1
outputs:
- name: portalId
path: $[*].id
labels: $[*].name
description: ID of the portal to manage
Step 3: List Pending Prospects
Retrieve the list of users who have requested access to the portal but are not yet members.
What you'll need:
api: urn:api:api-experience-hub-management
operationId: getProspects
inputs:
connectionId:
from:
variable: connectionId
description: Connection ID
portalId:
from:
variable: portalId
description: Portal ID
outputs:
- name: prospects
path: $.prospects[*]
labels: $.prospects[*].email
description: Pending prospects awaiting admin decision
- name: prospectId
path: $.prospects[*].id
description: Prospect ID used by the approve/reject operations
What happens next: Present the prospect list and let the admin choose who to approve or reject.
Step 4: Approve a Prospect
Promote a prospect to an active portal member and assign them to one or more user groups. Repeat per prospect the admin wants to approve.
What you'll need:
connectionId, portalId, prospectId- User-group IDs to assign (discover via
manage-portal-user-groups Step "List User Groups")
api: urn:api:api-experience-hub-management
operationId: approveProspect
inputs:
connectionId:
from:
variable: connectionId
description: Connection ID
portalId:
from:
variable: portalId
description: Portal ID
prospectId:
from:
variable: prospectId
description: The prospect being approved
approvalRequest:
userProvided: true
description: User groups to assign to the new member on approval
example:
userGroups:
- id: 00G1a000000abcD
outputs:
- name: approvedUserId
path: $.userId
description: The user
What happens next: The prospect is now a portal member with the chosen group assignments.
Step 5: Reject a Prospect (Optional)
Reject prospects who should not be granted access.
What you'll need:
connectionId, portalId, prospectId
api: urn:api:api-experience-hub-management
operationId: rejectProspect
inputs:
connectionId:
from:
variable: connectionId
description: Connection ID
portalId:
from:
variable: portalId
description: Portal ID
prospectId:
from:
variable: prospectId
description: The prospect being rejected
outputs:
- name: rejectedProspectId
path: $.id
description: The rejected prospect's ID (for audit)
What happens next: The prospect is removed from the queue. They can re-request access later.
Step 6: List Portal Members
Retrieve active portal members to audit who currently has access.
What you'll need:
api: urn:api:api-experience-hub-management
operationId: getCommunityUsers
inputs:
connectionId:
from:
variable: connectionId
description: Connection ID
portalId:
from:
variable: portalId
description: Portal ID
outputs:
- name: members
path: $.users[*]
labels: $.users[*].email
description: Active portal members
- name: userId
path: $.users[*].id
description: Portal-member user ID used by per-member operations
Step 7: Inspect a Member's User-Group Assignments
Fetch the specific group assignments of one member.
What you'll need:
connectionId, portalId, userId
api: urn:api:api-experience-hub-management
operationId: getCommunityUser
inputs:
connectionId:
from:
variable: connectionId
description: Connection ID
portalId:
from:
variable: portalId
description: Portal ID
userId:
from:
variable: userId
description: Portal-member user ID
outputs:
- name: memberUserGroups
path: $.userGroups[*]
labels: $.userGroups[*].name
description: Current user groups assigned to the member
What happens next: Present the current assignments; let the admin decide new memberships for Step 8.
Step 8: Update a Member's User-Group Assignments
Replace or extend the user groups assigned to a specific member.
What you'll need:
connectionId, portalId, userId- Target user-group IDs
api: urn:api:api-experience-hub-management
operationId: addGroupMappingToUser
inputs:
connectionId:
from:
variable: connectionId
description: Connection ID
portalId:
from:
variable: portalId
description: Portal ID
targetUserId:
from:
variable: userId
description: Portal-member user ID
userGroupsRequest:
userProvided: true
description: Full replacement set of user groups for this member
example:
userGroups:
- id: 00G1a000000abcD
- id: 00G1a000000efgH
outputs:
- name: updatedUserId
path: $.userId
description:
What happens next: The member now has exactly the user groups you specified.
Step 9: Disable a Portal Member (Optional)
Revoke a member's access without deleting their record — useful for offboarding.
What you'll need:
connectionId, portalId, targetUserId
api: urn:api:api-experience-hub-management
operationId: disableCommunityUser
inputs:
connectionId:
from:
variable: connectionId
description: Connection ID
portalId:
from:
variable: portalId
description: Portal ID
targetUserId:
from:
variable: userId
description: The member to disable
outputs:
- name: disabledUserId
path: $.userId
description: Confirmed disabled member ID
What happens next: The disabled member can no longer sign in to the portal. Their API contracts remain intact for audit.
Completion Checklist
What You've Built
✅ Governed Portal Membership — Prospects are triaged and approved members have the right user-group entitlements.
Next Steps
- Manage user groups themselves — See
manage-portal-user-groups to define the groups referenced here.
- Curate the visible catalog — See
curate-portal-assets to control which APIs members see.
- Monitor contracts — Track which approved members create consumer contracts against published APIs.
Related Jobs
- curate-portal-assets — Control which APIs and minor versions portal members see
- manage-portal-user-groups — Define and maintain the user groups assigned here
