MCP user tutorial
Use IQM Model Context Protocol (MCP) to interact with the User Management API.
Overview
This page provides instructions on using IQM MCP to perform operations related to user management, such as logging in and out, resetting or updating passwords, and updating user details such as profile information and status.
Before you begin
To access User Management API tools using IQM MCP, the following are required:
- An account on the IQM platform
- See Before you begin to create an account and request a Client ID and Client Secret
More resources
- Sign up and authenticate
- User Management API
- Account setup and management Help Center articles
User profile management
| Prompt | Response example | Notes |
|---|---|---|
| Show me my profile details | ||
| Let's update my profile | MCP prompts the user for details to update their profile. |
User app access
| Prompt | Response example | Notes |
|---|---|---|
| Show me a list of users | ||
| Show me user details for uowId 344281 | ||
| Show me app access for uowId 344281 | ||
| Revoke app ID 17 access for user 8407 | You can find userId in the user details response. | |
| Add app ID 17 access for user 8407 |
Tools index
In the tables below you can find the complete set of user management tools available in the MCP, categorized by function.
Each tool includes a brief description and a link to the corresponding API documentation for more details on its functionality and usage.
Use this index as a reference to explore the various user management capabilities of the MCP and how they relate to the User Management API endpoints.
Users
| Tool name | Description | Documentation |
|---|---|---|
getUserOWId | Get the logged in user's owId | |
getAccessibleOrganizations | Get organizations accessible to the current user | |
getUsersList | Get a paginated list of users | Get list of users |
getUsersBasicList | Get a basic paginated list of users | Basic user list |
sendUserInvitations | Send an invitation to a new user | Send user invitation |
resendUserInvitations | Resend an invitation to a user | Resend user invitation |
updateUserStatus | Update a user's active or inactive status | Update user status |
Profile
| Tool name | Description | Documentation |
|---|---|---|
getProfile | Get the current user's profile details | Get user profile details |
updateProfileDetails | Update the current user's profile information | Update user profile |
App access
| Tool name | Description | Documentation |
|---|---|---|
getAllowedApplications | Get a list of applications the user is permitted to access | Allowed applications list |
getUserApplicationsAccess | Get the user's application access list | User app access list |
addApplicationAccessToUser | Add application access for a user | Add app access for user |
revokeApplicationAccessToUser | Revoke application access for a user | Revoke app access for user |
getRemainingApplications | Get the remaining applications available to assign to a user | Remaining applications |
Password and MFA
| Tool name | Description | Documentation |
|---|---|---|
sendResetPasswordEmail | Send a password reset email | Reset password email |
resetPassword | Reset a user's password | Reset user password |
updateMfaFlag | Enable MFA for one or more users | Enable MFA |
disableMfaForUsers | Disable MFA for one or more users | Disable MFA |
Validation
| Tool name | Description | Documentation |
|---|---|---|
validateInvitation | Validate a user invitation link | Validate user invite |
validateResetPasswordInvitation | Validate a password reset link | Validate password reset hash |
validateUserEmail | Validate a user's email address | Validate user email |
validateWorkspaceForUser | Validate a workspace domain for a user | Validate Workspace domain |
validateCurrentPassword | Validate the current user's password | Validate user password |