MCP Server and Resource Metrics
- Server URL:
https://<domain>/auth/mcp - Total Tools: 102
- Total Error Codes: 5
Server Overview
The MCP server provides a robust suite of 102 tools designed for managing roles, privileges, sessions, collections, and authentication, enabling seamless user and client access control, dynamic privilege handling, and efficient data caching for enterprise applications.
Tools
The following table lists the available MCP tools for Authorization service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getFeatureByRoleId | This tool uses the `roleId` parameter to load features and provides responses for success, bad requests, forbidden access, or not found errors. |
|
|
| updateFeature RoleMapping |
This tool creates a FeatureRoleMapping using a unique role ID and provides responses for success, bad requests, forbidden access, or not found errors. |
|
|
| createFeatures RoleMapping |
This tool creates a FeatureRoleMapping using a unique roleId and provides responses for success, errors, or access issues. |
|
|
| deleteFeatures RoleMapping |
This tool loads a feature using the roleId and featuresPrivilegeMappingId, returning responses based on success or error codes. |
|
|
| getRolesOfUser | This tool retrieves all roles associated with a user based on their identifier, supporting multiple roles per user and detailed response codes for success or errors. |
|
|
| replaceRolesOfUser | This tool manages user roles by adding or removing them across collections, using user and business identifiers, with responses indicating success or errors. |
|
|
| deleteRolesOfUser | This tool removes specified roles from a user, with parameters for user and business identifiers, and returns success or error responses. |
|
|
| getUserAttribute | This tool retrieves user privilege attributes using a valid identifier and provides detailed responses for success or errors. |
|
|
| replaceUserAttribute | This tool updates a user’s privilege attribute using provided details and returns success or error responses based on the operation. |
|
|
| deleteUserAttribute | This tool deletes a user’s privilege attribute using a provided identifier, returning success or error responses based on the operation’s outcome. |
|
|
| getRole | This tool retrieves role details, supports parameters for business context and privilege loading, and provides structured responses for success or errors. |
|
|
| replaceRole | This tool updates a role using the provided name, description, privileges, and identifiers, with detailed response codes for success or errors. |
|
|
| deleteRole | This tool deletes a specified role using roleId and optional businessId, returning success or error responses based on the request. |
|
|
| updateRole | This tool updates a role’s attributes like name, description, and privileges using a valid role identifier, with responses indicating success or specific errors. |
|
|
| getPrivilegeSet | This tool retrieves the privilege set details using a unique privilegeSetId, with optional dependency loading and various response codes. |
|
|
| replacePrivilegeSet | This tool updates a specified privilege set using a unique ID and provides detailed responses for success or errors. |
|
|
| deletePrivilegeSet | This tool deletes a specified privilege set using its unique ID and returns success or error responses. |
|
|
| getPrivilege | This tool retrieves privilege details based on provided parameters, returning success or error responses in JSON format. |
|
|
| replacePrivilege | This tool updates a specified privilege using the provided request parameters and returns detailed success or error responses. |
|
|
| deletePrivilege | This tool deletes a specified privilege using privilegeId and optional businessId, returning success or error responses. |
|
|
| getGroupAttribute | This tool retrieves a specified group attribute using its unique ID and returns detailed information or error responses based on the request outcome. |
|
|
| replaceGroupAttribute | This tool updates a specified group privilege attribute using a unique groupattributeId, returning success or error responses in JSON format. |
|
|
| deleteGroupAttribute | This tool deletes a specified group attribute using its unique ID, returning success or error responses based on the operation. |
|
|
| getDynamicPrivilege | This tool retrieves dynamic privilege details using the dynamic privilege ID and provides structured responses for success, errors, or forbidden access. |
|
|
| replaceDynamicPrivilege | This tool updates dynamic privilege details using a unique ID, returning success or error responses with relevant information. |
|
|
| deleteDynamicPrivilege | This tool deletes a specified dynamic privilege using its unique ID and returns success or error responses. |
|
|
| getCollection | This tool retrieves a collection based on a provided collection ID, with responses indicating success or various error states. |
|
|
| replaceCollection | This tool updates a collection by collection ID, requiring name, description, and status, while prohibiting updates to collection ID and business ID. |
|
|
| replaceCollection Properties |
This tool updates collection properties for a specified collection ID, with parameters for business ID, locale, and various response codes. |
|
|
| updateCollection Properties |
This tool updates the properties of a collection identified by collectionId, with responses indicating success or various error states. |
|
|
| getRolesOfClient | This tool retrieves all roles associated with a client entity, supporting multiple roles per client and detailed responses for success or errors. |
|
|
| replaceRolesOfClient | This tool manages client roles by adding or removing them across collections, using client and business identifiers with detailed response codes. |
|
|
| deleteRolesOfClient | This tool removes specified roles from a client using valid identifiers, with responses indicating success or various errors. |
|
|
| getAuthGroup | This tool retrieves authgroup details using a unique identifier and provides responses for success, errors, or not found scenarios in JSON format. |
|
|
| replaceAuthGroup | This tool updates an authgroup’s name and description using its unique identifier, returning success or error responses based on the operation’s outcome. |
|
|
| deleteAuthGroup | This tool deletes a specified authgroup by its unique identifier, returning success or error responses based on the request outcome. |
|
|
| getFeaturePrivilegeById | This tool retrieves feature privilege details using a unique feature privilege ID and provides responses for success, bad request, forbidden, or not found scenarios. |
|
|
| updateFeatures PrivilegeMapping |
The tool updates privilege mappings for a specified feature ID, returning success or error responses based on input validity. |
|
|
| deleteFeatures PrivilegeMapping |
This tool deletes a specified feature and its privilege mapping, returning detailed response codes and messages for success or errors. |
|
|
| getUserAttributes | This tool retrieves user privilege attributes from a specified collection, supports query parameters for filtering, pagination, and provides structured responses for success or errors. |
|
|
| createUserAttribute | This tool creates a user privilege attribute using provided attribute values, user identifiers, and privilege identifiers, with detailed response codes for success or errors. |
|
|
| getRolesOfUsers | This tool retrieves user roles from specified collections with filtering, sorting, pagination, and detailed response/error handling. |
|
|
| addRolesToUsers | This tool assigns roles to users, validates existing roles, supports multiple roles per user, and provides detailed responses for success or errors. |
|
|
| getSession | This tool retrieves session details using a mandatory session ID and requires valid tokens for authentication and authorization. |
|
|
| createSession | This tool creates a user session using a user ID, bearer token, and collection ID, generates tokens for storefront users, and specifies configurable expiry times for auth and refresh tokens. |
|
|
| deleteSession | This tool removes a session using its identifier, validates its cache availability, and returns responses like success (200), bad request (400), forbidden (403), or not found (404). |
|
|
| refreshSession | This tool extends user sessions by validating session ID and refresh token, issuing new tokens with configurable expiry times, and handling responses for success or errors. |
|
|
| refreshApi | This tool updates secret keys without restarting, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters. |
|
None |
| createSecretkey | This tool generates a secret key using a provided business ID and returns various responses based on request validity. |
|
|
| getRoles | This tool retrieves roles from a specified collection, supports user-role associations, and offers filtering, sorting, and pagination options. |
|
|
| createRole | This tool creates a new role with a name, description, privileges, and returns details or error responses based on the operation outcome. |
|
|
| getPrivilegeSetsOfRole | This tool retrieves privilege sets for a specified role using a valid role identifier. |
|
|
| addPrivilegeSetsToRole | This tool assigns a list of privilege sets to a specified role using a valid role identifier. |
|
|
| removePrivilege SetsOfRole |
This tool removes privilege sets from a specified role using a valid role identifier, with responses indicating success or various error states. |
|
|
| getPrivilegeSets | This tool retrieves privilege sets under a specified collection, supports filtering, pagination, and provides detailed responses for success or errors. |
|
|
| createPrivilegeSet | This tool creates a new privilege set using the provided name, description, and privileges, with detailed success and error response formats. |
|
|
| getPrivilegesOfPrivilege Set |
This tool retrieves all privileges from a specified privilege set using its unique ID, returning success or error responses in JSON format. |
|
|
| addPrivilegesToPrivilege Set |
This tool adds privileges to a specified privilege set using a unique ID and provides various response codes for success or errors. |
|
|
| removePrivilegesOf PrivilegeSet |
This tool removes specified privileges from a given privilege set, returning success or error responses based on the operation. |
|
|
| getPrivileges | This tool retrieves authorization privileges for a specified collection using query parameters like businessId, offset, limit, and filter, with responses indicating success or errors. |
|
|
| createPrivilege | This tool creates a new privilege using provided details like name, description, action, and microservice, with responses indicating success or various error states. |
|
|
| getOAuthClients | This tool retrieves OAuth clients for a specified collection ID using query filters, sorting, pagination, and locale parameters. |
|
|
| createOpenIdClient | This tool generates an OAuth client with a unique client ID, secret, and associated properties, returning success or error responses based on the request. |
|
|
| authorize | This tool generates a user’s `id_token` for accessing a client application using valid session and client identifiers, with specified query parameters and response formats. |
|
|
| getOAuthClients_1 | This tool retrieves an access_token using clientId, clientSecret, grantType, audience, and domain, with detailed success and error responses. |
|
|
| getGroupAttributes | This tool retrieves group-specific privilege attributes for access control within a collection, supports filtering, pagination, and provides detailed response codes. |
|
|
| createGroupAttribute | This tool creates a new group attribute using the provided attribute value, authgroup ID, and privilege ID, with detailed response codes for success or errors. |
|
|
| getDynamicPrivileges | This tool retrieves dynamic privileges from a collection with filtering, pagination, and detailed response structure. |
|
|
| createDynamicPrivilege | This tool creates a dynamic privilege based on the request and returns appropriate responses for success or errors. |
|
|
| cacheClear | This tool clears cached data based on specified cache names, supports string-type keys, and can clear the entire cache if no key or pattern is provided. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and provides JSON responses for success or various error codes. |
|
|
| getCollections | This tool loads microservice collections based on search terms, enabling storefronts to fetch/store associated data with configurable properties and filters. |
|
|
| createCollection | This tool creates a collection for a specified business and provides detailed responses for success or errors. |
|
|
| createSession_1 | This tool creates a client session using client ID, bearer token, and collection ID, with configurable token expiry times and response codes for success or errors. |
|
|
| deleteSession_1 | This tool removes a session by its identifier, validates its cache availability, and provides detailed responses for success or errors. |
|
|
| getRolesOfClients | This tool retrieves client roles based on specified collections, with query parameters for filtering, sorting, pagination, and business identification, returning JSON responses for success or errors. |
|
|
| addRolesToClients | This tool assigns roles to clients, validates existing roles, and provides detailed responses for success or errors. |
|
|
| getAuthGroups | This tool retrieves authgroups under a specified collection, managing user roles, with pagination, filtering, and detailed response properties. |
|
|
| createAuthGroup | This tool creates an authgroup to manage users with shared roles under a specified collection, returning success or error responses based on the operation’s outcome. |
|
|
| getUsersOfAuthGroup | This tool retrieves user identifiers for a specified authgroup using its valid identifier, with responses indicating success or various error states. |
|
|
| addUsersToAuthGroup | This tool adds a list of users to a specified authgroup based on the provided authgroupId. |
|
|
| removeUsersOfAuthGroup | This tool removes specified users from a given authgroup using valid identifiers, with responses for success or errors. |
|
|
| getRolesOfAuthGroup | This tool retrieves roles of a specified authgroup within a collection, providing detailed response properties and error handling. |
|
|
| addRolesToAuthGroup | This tool adds specified roles to an authgroup using its unique identifier, returning success or error responses. |
|
|
| removeRolesOfAuthGroup | This tool removes specified roles from an authgroup using valid identifiers, returning success or detailed error responses. |
|
|
| createFeatures PrivilegeMapping |
Create Features and PrivilegeMapping tool provides success, error, or forbidden responses with detailed properties and examples. |
|
|
| getOAuthClientById | This tool retrieves an OAuth client by client ID and collection ID, returning detailed client properties or error responses. |
|
|
| deleteOAuthClient | This tool deletes an OAuth client using the specified client ID and collection ID, with responses for success, errors, or forbidden access. |
|
|
| updateOpenIdClient | This tool updates an OAuth client using a specified client ID and collection ID, with options for refreshing keys and supporting various response codes. |
|
|
| getAggregatedAccess | Executes a GET request for user access aggregation using a unique userId, returning JSON responses for success or various error codes. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, cleans instance data for AWS calls, and requires `keyName` and `resetRequired` parameters. |
|
None |
| rabbitMQUpdate Credentials |
This tool updates RabbitMQ credentials, cleans instance data for AWS calls, and requires `keyName` and `resetRequired` parameters with various response codes. |
|
None |
| refreshApi_2 | This tool updates secret keys without restart, cleans instance data for AWS calls, and uses `keyName` and `resetRequired` parameters with detailed response codes. |
|
None |
| getReleaseDefinition | This tool retrieves the release definition of a service with detailed response codes and validation error information. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and their privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter, returning JSON responses for success or various error codes. |
|
|
| authPing | This tool provides a timestamp to confirm service status and includes detailed error responses for various HTTP codes. |
|
None |
| getJSONWebKeySet | This tool retrieves an OAuthClient’s public key (JWKS) for validating the `id_token` using a unique client identifier. |
|
|
| getCacheValue | This tool retrieves cached data for a specified service using string-based cache name and key, with responses including success, bad request, forbidden, or not found. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service based on a specified Redis regex pattern, with default as ‘*’. |
|
None |
| getCollectionProperty ByCollectionId AndPropertyName |
This tool retrieves a collection property by name using specified path and query parameters, returning JSON responses for success or error scenarios. |
|
|
| getCollectionAttributes | This tool retrieves collection attributes for a microservice, supports locale-based responses, and provides detailed success or error responses in JSON format. |
|
|
| cacheClearByName | The `cacheClearByName` tool clears a specified cache by name, returning success or detailed error responses. |
|
None |
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | (Success): Created |
| 201 | (Success): User’s Role Added |
| 400 | Bad Request |
| 403 | Forbidden |
| 404 | Not Found |
Useful Resources
- API Specifications: API Endpoints – Authorization
- Services Details: Authorization Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added