Home
MATRIXX Subscriber Management API
REST API Reference
This part describes how to use the REST API bindings to interface with MATRIXX Engine.
User REST APIs
Use the User REST APIs to add, update, query, and delete users. You can also get and modify user authentication data, associate users with groups and subscriptions, and modify or remove those associations.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
- About Subscriber Management API
  MATRIXX Subscriber Management API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.
- Subscriber Management
  The following information is an overview of the SubMan APIs and architecture.
- Object Management
  The following sections introduce how the various in-memory objects are managed.
- SubMan API Reference
  The SubMan API reference includes SubMan API and MDC descriptions.
- REST API Management
  RS Gateway supports the REST API bindings for accessing subscriber data in MATRIXX Engine. RS Gateway consists of an rsgateway application and a set of REST APIs.
- REST API Reference
  This part describes how to use the REST API bindings to interface with MATRIXX Engine.
  - Deprecated APIs
    The following APIs are deprecated in this release of MATRIXX and support for these APIs will be removed in a future release.
  - Balance, Meter, and Wallet REST APIs
    The balance management APIs include the messaging required to operate on a balance, meter, or wallet object. The primitives include the messaging and data elements required to create, modify, associate, and query objects directly related to a balance or meter, including their thresholds.
  - Catalog REST APIs
    The catalog APIs return information about pricing catalogs for specified devices, groups, and subscriptions. They return catalog items that the specified object is eligible to purchase.
  - Data Migration MDCs
    Use the following MDCs to import data for users, subscriptions, groups, and devices and to import catalog item purchase information for a subscription.
  - Device REST APIs
    The device management APIs include the methods and functions required to operate on the device primary object. They include the data elements required to create, modify, and query devices, to add and remove a device from a subscription, and to delete a device from the Subscriber database.
  - Eligibility Rules REST APIs
    This section describes the APIs for querying catalog items based on eligibility. The APIs return catalog items that the specified object is eligible to purchase.
  - Event REST APIs
    The event APIs include the messaging and elements to return events and notifications in the Event Repository and the event database for subscriptions, groups, and users.
  - External Payment REST APIs
    External payment APIs query external payment requests and get a list of external payment request records in a wallet.
  - Gateway REST APIs
  - Group REST APIs
    The group management APIs include the messaging required to operate on the group object. The APIs include the messaging and data elements required to create, modify, associate, and query objects directly related to the group.
  - Multi-Tenant REST APIs
    The multi-tenant APIs get tenant information for individual tenants and all tenants.
  - My MATRIXX REST APIs
    My MATRIXX supports GET, PUT, and POST REST bindings. The { } notation around text represents a URL parameter.
  - Offer Life Cycle REST APIs
    Use these APIs to query a list of status life cycles for an offer. You can query specific offer status life cycle using the profile ID.
  - Pay Now REST APIs
    The integration layer REST APIs manage payment authorization tokens for the payment gateway from the integration layer. These tokens are necessary for the client to communicate directly with the payment gateway to create a payment method in the payment gateway.
  - Policy REST APIs
    The policy APIs allow you to query the Sy policy counters for a specific device.
  - Pricing REST APIs
    The pricing management APIs return information about all aspects of pricing, including catalog items, balance templates, product offers, billing cycles, life cycles, notifications and so forth. You can also get status information for the currently-loaded pricing.
  - Product Offer REST APIs
    The product offer management APIs include the messaging to activate, purchase, cancel, and modify catalog items. You can identify a product offer by its object ID or the external ID assigned during pricing plan creation.
  - Purchase Package REST APIs
    Use the purchase package APIs to manage catalog items in a purchase package, including adding and removing catalog items for subscriptions, groups, and devices, and suspending, resuming, and canceling purchase packages.
  - Recurring Charge
    The MtxRequestSubscriberEstimateRecurringCharge SubMan API estimates balance impacts from recurring processing of currently failing recurring cycles and upcoming recurring cycles (active purchased items cycles, balance cycles and billing cycles).
  - Rehoming REST APIs
    The rehoming APIs move a subscription, group, device, or user from one customer sub-domain to a different sub-domain. For a description of the rehoming process, see the discussion about rehoming subscribers, groups, devices, and users in the object management overview.
  - Service APIs
    The extended REST service APIs are implemented only in the RS Gateway. These APIs include REST services that manage subscribers, groups, and devices, including rehoming operations. In addition, you can start and stop rating sessions using the service APIs. Unlike the APIs described in MATRIXX Subscriber Management API, these APIs do not have a Python or Java equivalent. For information about the service API default filters, see the discussion about REST filters.
  - Status Life Cycle REST APIs
    Use these APIs to query status life cycle information for devices, groups, subscriptions, and users from the engine.
  - Status Modify APIs
    The status modify APIs schedule status changes and delete scheduled status changes. They also suspend and resume purchased items (product offer or bundle) if the current offer status class permits the action.
  - Subscriber REST APIs
    The Subscriber REST APIs described here are deprecated and will be removed in a future release.
  - Subscription REST APIs
    The subscription management APIs include the messaging required to operate on the subscriber object, which is a primary object for MATRIXX interactions. The API bindings include the messaging and data elements required to create, modify, and query objects directly related to the subscription. A subscription must have a wallet secondary object, which is created for the subscription at subscription creation time.
  - System REST APIs
    The system REST APIs query the MATRIXX Engine to check if recurring recharge is enabled, return domain and sub-domain information, return tenant IDs, and create Pay Now client tokens.
  - Tax REST APIs
    The tax APIs manage information in the US Tax database.
  - User REST APIs
    Use the User REST APIs to add, update, query, and delete users. You can also get and modify user authentication data, associate users with groups and subscriptions, and modify or remove those associations.
    - DELETE /user/{SearchTerm:.+}/group/{GroupTerm:.+}
      This method is used to remove a group from a user.
    - DELETE /user/{SearchTerm:.+}/subscription/{SubTerm:.+}
      This method is used to remove a subscription from a user.
    - DELETE /user/{SearchTerm:.+}
      This method is used to delete a user in the database.
    - GET /user/{SearchTerm:.+}
      This service implements the retrieval of a user using the Object ID for the user. This value MUST be passed in as part of the URL.
    - GET /user/{SearchTerm:.+}/events
      This method is used to search for events in the MATRIXX in-memory database and retrieve information on events associated with the user. querySize: An optional request parameter (default is 0=system default). It specifies the number of records returned per call. queryCursor: If the query results do not fit in a single response, a QueryCursor is included in the response. If the cursor is NULL or 0 you are at the end. You can retrieve the subsequent pages of a response by calling this URL again but specifying a queryCursor parameter on the url.
    - GET /user/{SearchTerm:.+}/authentication
      This method is used to retrieve a user's authentication data in the database. It requires an MtxRequestUserQueryAuthData message be PUT to the server. Leave off the UserSearchData field, as it will be set from information passed in the URL.
    - GET /user/{SearchTerm:.+}/groups
      This service implements the retrieval of the groups with which this user is associated. querySize=xx: An optional request parameter querySize (default is 0=system default) can be specified that determines the number of records returned per call. queryCursor=yy: If the query results do not fit in a single response, a QueryCursor is included in the response. If the cursor is NULL or 0 you are at the end. You can retrieve the subsequent pages of a response by calling this URL again but specifying a queryCursor parameter on the url.
    - GET /user/{SearchTerm:.+}/subscriptions
      This service implements the retrieval of the subscriptions with which this user is associated. querySize=xx: An optional request parameter querySize (default is 0=system default) can be specified that determines the number of records returned per call. queryCursor=yy: If the query results do not fit in a single response, a QueryCursor is included in the response. If the cursor is NULL or 0 you are at the end. You can retrieve the subsequent pages of a response by calling this URL again but specifying a queryCursor parameter on the url.
    - POST /user/{SearchTerm:.+}/group/{GroupTerm:.+}
      This method is used to add a group to a user.
    - POST /user/{SearchTerm:.+}/subscription/{SubTerm:.+}
      This method is used to add a subscription to a user.
    - POST /user
      This method is used to create a user. You must POST an MtxRequestUserCreate message with the request that contains the user information.
    - PUT /user/{SearchTerm:.+}/authentication
      This method is used to modify a user's authentication data in the database. It requires an MtxRequestUserModifyAuthData message be PUT to the server. Leave off the UserSearchData field, as it will be set from information passed in the URL.
    - PUT /user/{SearchTerm:.+}/group/{GroupTerm:.+}
      This method is used to modify a group to a user roles.
    - PUT /user/{SearchTerm:.+}
      This method is used to modify user subscriber in the database. It requires an MtxRequestUserModify message be PUT to the server. Leave off the UserSearchData field, as it will be set from information passed in the URL.
    - PUT /user/{SearchTerm:.+}/subscription/{SubTerm:.+}
      This method is used to modify a subscription to a user roles.
    - PUT /user/{query:.+}/rehome/{destination}
      This service rehomes a user.
- Java API
  This part provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

User REST APIs

Use the User REST APIs to add, update, query, and delete users. You can also get and modify user authentication data, associate users with groups and subscriptions, and modify or remove those associations.

User objects are stored in the subscriber database. Each user has a unique OID. A user object can have a specific type defined by a user extension in the Attr field.

MATRIXX Engine generates an MtxUserModifyEvent EDR when one or more of the following fields are modified:

ExternalId
UserId
FirstName
LastName
ContactEmail
ContactPhoneNumber
NotificationPreference
Attr
Language

An MtxUserCreateEvent EDR is generated only when a user is created with the UserCreate APIs. An MtxUserDeleteEvent EDR is generated only when a user is deleted with the UserDelete APIs. When deleting a user, you can also delete a user device, subscription, or session.

Note: Child objects (subscriptions, devices) are unlinked and deleted if the corresponding parameter is specified. Life cycle properties are not checked for child objects. Ensure these child objects are in a life cycle deletion state so that any life cycle actions related to deleting these objects have already been performed.

For more information about EDRs, see MATRIXX Integration.