MCP Server and Resource Metrics
- Server URL:
https://<domain>/user/mcp - Total Tools: 74
- Total Error Codes: 9
Server Overview
The MCP server provides a robust suite of 74 tools designed to manage user profiles, consents, security, collections, attributes, and system configurations, enabling seamless operations, enhanced security, and tailored storefront experiences for businesses.
Tools
The following table lists the available MCP tools for Customers (User) service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getUser | This tool retrieves user profile information, including personal details, addresses, credentials, and custom properties, with options for full or partial data based on query parameters. |
|
|
| putUser | This tool allows users or admins to update user profiles with unique identities and various attributes, while restricting updates for users with NOTACTIVATED status. |
|
|
| deleteUser | This tool permanently deletes the specified user from the database using unique identifiers and optional locale or business parameters, returning success or error responses. |
|
|
| updateUser | This tool updates user profile information, validates unique identities, and allows admins with CSR roles to modify profiles, excluding users with NOTACTIVATED status. |
|
|
| getSecurityQuestionsByUserId | This tool retrieves security questions and answers for active users based on their unique ID, with responses rendered in the specified locale. |
|
|
| updateSecurityQuestion | This tool updates security questions and answers for ACTIVE users based on their unique user ID, with locale-specific responses and error handling. |
|
|
| getCollection | This tool retrieves collection details based on a given identifier, validates input, and supports storefront association for microservice instances with configurable properties. |
|
|
| updateCollection | This tool updates a microservice’s user collection, allowing modification of all attributes and properties, with store associations enabling storefront data access. |
|
|
| updateCollectionProperties | This tool updates collection properties based on the request, enabling microservice customization and store associations for tailored storefront experiences. |
|
|
| updateCollectionProperty | This tool updates a microservice’s collection properties based on the provided request, enabling tailored behavior and store associations for storefront operations. |
|
|
| getUsers | This tool retrieves user profile information with flexible search, sort, pagination, and filtering options, supporting various query parameters and response codes. |
|
|
| createUsers | This tool facilitates user creation as registered, guest, or subscribe users with varying statuses and attributes based on input parameters and configurations. |
|
|
| getNotes | This tool retrieves all notes of a user based on user ID, pagination, and locale parameters, returning JSON responses for success or errors. |
|
|
| createNote | This tool allows creating notes with mandatory title and description fields for users, except in DELETED status, while supporting locale-specific responses. |
|
|
| getUserConsents | This tool retrieves user consents based on preferences like opt-in/out options, using parameters for user ID, pagination, and locale, with detailed success and error response formats. |
|
|
| createUserConsents | This tool creates user-specific consent preferences, capturing consent details and user identifiers, with responses for success, errors, or server issues. |
|
|
| getAddresses | This tool retrieves all available addresses for a specified user, excluding DELETED users, with optional filters and locale-specific responses. |
|
|
| createAddress | This tool allows an active user to create a single shipping address, configure address limits, and manage default address settings. |
|
|
| getSecurityQuestions | This tool retrieves security questions for active users to reset passwords, with responses in specified locales and error handling for various status codes. |
|
|
| validateSecurityQuestions | This tool resets active users’ passwords by validating security questions and supports locale-specific responses with various status codes. |
|
|
| resetPassword | This tool generates an encrypted reset parameter for password recovery, tied to user ID and timestamp, and provides locale-specific responses for success, errors, or server issues. |
|
|
| validateResetPassword | This tool resets user passwords using a time-limited reset parameter generated by the `POST /users/password` tool, validating inputs from email/SMS and supporting locale-specific responses. |
|
|
| loginUser | This tool supports multiple identity types (DEFAULT, CUSTOM, GOOGLE, FACEBOOK, FIREBASE), MFA, user merging, and configurable properties for login attempts, OTP validation, and resend limits. |
|
|
| sendNotification | This tool triggers two-factor authentication for user actions, generates an encrypted token or OTP, and publishes it to a notification event for external services to send alerts via email or SMS. |
|
|
| validateNotification | This tool validates two-factor authentication using tokens or SMS within a set time, allowing users to proceed with actions if successful. |
|
|
| sendActivation | This tool generates an activation parameter for non-ACTIVE users identified by email or phone, displayed in UsersResponse under custom properties as `lastactivationparam`. |
|
|
| validateActivation | This tool validates a user’s activation token, updates their status to ACTIVE upon success, enforces a 1-hour expiry constraint, and requires a new activation request on failure. |
|
|
| refreshApi | This tool sets secret keys without restart, clears instance data for updated AWS calls, requiring `keyName` and `resetRequired` parameters. |
|
None |
| cacheClear | This tool clears cached data for specified cache names, supports string-type keys, and clears entire cache if no key or pattern is provided. |
|
|
| cacheClear_1 | This tool clears cached data using a dynamic cache key and returns a JSON response with code, message, and timestamp upon success. |
|
|
| getConsents | This tool retrieves user consents based on search filters, including pagination, locale, and query criteria, with detailed response formats for success and error cases. |
|
|
| createConsent | This tool enables the creation of user consent preferences, validates input, and saves changes to the database with localized responses and detailed status codes. |
|
|
| getCollections | This tool retrieves user collections with optional filters, sorting, pagination, and locale settings. |
|
|
| createCollection | This tool creates a user collection as the topmost microservice entity, configurable per instance, enabling storefronts to fetch/store associated data based on provided parameters. |
|
|
| getBlackList | This tool retrieves blacklist information with search, pagination, and filtering options, returning responses in JSON format based on query parameters and status codes. |
|
|
| createBlackListItem | This tool allows creating BlackListItems with specified type and value, except in DELETED status, and provides locale-specific responses for various success and error scenarios. |
|
|
| getAttributes | This tool retrieves attributes based on valid collectionId, with parameters for locale, page, size, filter, and sort criteria, returning paginated JSON responses. |
|
|
| createAttribute | This tool retrieves a valid attribute by its ID, providing detailed response properties including name, type, status, and validation data. |
|
|
| getCustomProperties | This tool fetches all custom properties of an active user using their unique ID, with responses rendered in the specified locale. |
|
|
| updateCustomProperty | This tool updates user custom properties, supports locale-specific responses, and provides detailed success or error feedback. |
|
|
| updatePassword | This tool updates an active user’s password after validating the old password or directly if not provided, using userId and optional locale parameters. |
|
|
| getAddress | This tool fetches the specified user’s address from the database, excluding DELETED users, using path and query parameters with detailed validation and response formats. |
|
|
| deleteAddress | This tool deletes the specified address of an active registered user based on userId and addressId parameters, with responses rendered in the specified locale. |
|
|
| updateAddress | This tool updates the active user’s address, allowing only one update at a time and overriding the default address based on provided values. |
|
|
| updateMfaAuthenticator | This tool updates the MFA authenticator status for a user based on their unique ID, with responses rendered in the specified locale. |
|
|
| getConsent | This tool retrieves user preferences (consents) by consent ID, regardless of status, with optional locale-specific responses. |
|
|
| deleteConsent | This tool permanently deletes a specific user consent identified by its unique ID, with responses rendered in the specified locale. |
|
|
| updateConsent | This tool updates user-specific consent preferences, including optional fields like title, status, and requiredFlag, based on provided values. |
|
|
| getAttribute | This tool retrieves valid attribute details by ID, supports locale-specific responses, and provides comprehensive attribute properties in JSON format. |
|
|
| deleteAttribute | This tool deletes an attribute using a unique attribute ID and provides locale-specific responses with a 204 status for success. |
|
|
| updateAttribute | This tool updates specific fields of an attribute using `AttributeID`, validates provided data, and returns detailed attribute information in the specified locale. |
|
|
| getCustomProperty | This tool retrieves specified user properties from the database for ACTIVE users based on unique user ID or name, with responses rendered in the provided locale. |
|
|
| deleteCustomProperty | This tool removes a specified custom property for a user based on their unique ID and property name, with responses rendered in the specified locale. |
|
|
| getIdentities | This tool retrieves user identities (email, phone, etc.), including type (registered/guest) and status (ACTIVE, INACTIVE, etc.), based on userId and optional locale. |
|
|
| getUserConsentHistories | This tool retrieves a user’s consent history, including preferences and identifiers, with pagination and locale options. |
|
|
| getUsers_1 | This tool retrieves a user’s public profile based on exact filter criteria, supports pagination, sorting, and locale configuration, and returns response codes with detailed messages. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, clears instance data for AWS updates, and requires `keyName` and `resetRequired` parameters. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, clears instance data for AWS updates, and requires keyName and resetRequired parameters. |
|
None |
| refreshApi_2 | This tool sets secret keys without restart, updates AWS call values, and requires `keyName` and `resetRequired` parameters. |
|
None |
| getAllStandrdRoles | This tool retrieves and filters standard roles and privileges from `roles_privileges.json` but has been deprecated since Infosys Equinox Commerce Release 8.3.0. |
|
|
| getReleaseDefinition | This tool retrieves the release definition of a service and provides structured responses for success, errors, or resource not found. |
|
None |
| getAllPrivileges | This tool fetches service privileges listed in `roles_privileges.json` within the microservice classpath, returning them as JSON on success. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and their privileges from a service’s `roles_privileges.json` file based on the `privilegeGroupName` parameter. |
|
|
| ping | This tool verifies if the user service is operational. |
|
None |
| getCacheValue | This tool retrieves cached data for a service using a specified string-based cache name and cache key. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service using a specified Redis regex pattern, defaulting to ‘*’. |
|
None |
| getCollectionProperty | This tool retrieves a collection’s property using its ID and name, enabling microservice customization and store association for tailored storefront experiences. |
|
|
| getAttributes_1 | This tool retrieves collection attributes for a microservice, enabling configuration and store association, with responses for success, errors, or forbidden access. |
|
|
| cacheClear_2 | This tool clears all caches and returns a success response in JSON format. |
|
None |
| cacheClearByName | This tool clears caches by specified cache name and returns a success response. |
|
None |
| cacheClearByNameAndKey | This tool clears the cache using specified cache name and cache key, returning a JSON response upon success. |
|
None |
| deleteNote | This tool deletes a specific user’s note using unique IDs and supports locale-based responses. |
|
|
| deleteUserConsent | This tool deletes specific user consent based on user and consent IDs, with locale-based responses and error handling. |
|
|
| deleteBlackList | This tool deletes a specific BlackListItem by its ID, with optional locale-based responses and various status codes. |
|
|
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | (Success): OK |
| 201 | User Created |
| 202 | (Success): Accepted |
| 204 | (Success): No Content |
| 400 | Bad Request |
| 403 | Forbidden |
| 404 | Resource Not Found |
| 422 | Input validation failed |
| 500 | Internal Server Error occurred |
Useful Resources
- API Specifications: API Endpoints – Customers (User)
- Services Details: Customers (User) Overview
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added