Log In Using JSON

This task describes how to log in to MATRIXX Backoffice Customer Tool using a JSON POST call.

Before you begin

Define the MATRIXX Backoffice Customer Tool users and assign one or more of the following roles to each user.
- MTX_ROLE_CSR — Enables read-only access to MATRIXX Backoffice Customer Tool.
  Important: This role is mandatory.
- MTX_ROLE_CSR_MGR — Enables write access to balances and thresholds in MATRIXX Backoffice Customer Tool.
  Note: The balance and meter information displayed in MATRIXX Backoffice Customer Tool is determined by the balance attributes configured in balance templates in My MATRIXX. By default, all balances are displayed. If a balance should not be displayed, the display attribute in the balance template must be set to "none." For more information about configuring balance attributes, see MATRIXX Pricing and Rating.
- MTX_ROLE_ADMIN — Enables full edit access to MATRIXX Backoffice Customer Tool except for bulk operations.
- MTX_ROLE_SIMULATE — Enables access to MATRIXX Backoffice Customer Tool usage simulation functionality.
- MTX_ROLE_EVENT — Enables access to viewing subscription, group, and user event data. This role is used in combination with the MTX_ROLE_CSR role.
- MTX_ROLE_BULK_OPS — Enables access to viewing a bulk operation configuration and adding and deleting a bulk operation task.
For more information, see the discussion about defining the MATRIXX Backoffice Customer Tool users in MATRIXX Security.
Configure the following header settings in your REST client:
- Content-type — application/json
- Accept — application/json

Procedure

Set the request method to POST.
Set the request URL address to the following.
http://ip_address:port_number/matrixxbct/login
where:
- ip_address is the IP address or hostname of MATRIXX Backoffice Customer Tool host pod.
- port_number is the port number used to serve MATRIXX Backoffice Customer Tool web pages.
Configure the request body with your username and password.
For example:
```
{"j_username":"username", "j_password":"password"}
```
where:
- username is your MATRIXX Backoffice Customer Tool username.
- password is your password.

Send the request.

If the request is successful, a SUCCESS status, the username, and assigned roles are returned. For example:

{
  "HttpStatusCode":200,
  "_resultType":"POST",
  "Results":[ 
    {
      "Session":"5D2A34AE2B7DEBB54C912E2EEC772E5F",
      "Status":"SUCCESS",
      "User": {
        "Name": "admin",
        "Roles": [
          "MTX_ROLE_ADMIN",
          "MTX_ROLE_CSR",
          "MTX_ROLE_CSR_MGR",
          "MTX_ROLE_SIMULATE"
        ]
      }
    }
  ],
  "_resultCode":0,
  "_resultText":"OK"
}

Results

Note: To log out of MATRIXX Backoffice Customer Tool, set the request method to GET and set the request URL to the following.

http://ip_address:port_number/matrixxbct/logout

where:

ip_address is the IP address or hostname of MATRIXX Backoffice Customer Tool host server.
port_number is the port number used to serve MATRIXX Backoffice Customer Tool web pages.