User License Activity/API

Simscope has multiple methods to check user license activity.

Note: inspecting license activity requires Administrator user privileges to view in Simscope.

User Accounts

You can view user activity and license accounts available in Simscope by going to:

• Misc → User Accounts

Notes:

• If you click the Online column, this will sort the user table by most-recently-active in Simscope, down to least-recently-active.
• Administrators can disable user accounts which are no longer active. This will add a license back to the pool.

Example

This example shows 76 active users, and 24 user seats available (ie 100 user seat license).

• In this example, David Roy is the most recent user online (based on sorting).

Notes on Licenses

• The admin (Administrator) account is a special account, and does not use a license seat.
• License Seats are based on the number of non-disabled user accounts, even if the user has not logged into Simscope recently.
• Only active users are allowed to view data in Simscope, can be assigned signatures, and can receive regression/chart emails directly.
• Only active users can use API tokens for scripts.

Email CC's:

• You can add a CC (email carbon-copy) to any email address (or distribution list) for any Regression Search or Chart Notification, and this CC address does not use a license key.

Publishing Regressions/Jobs (RabbitMQ):

• Simscope does not use a license to publish Regression/Job JSON data. Any number of users can publish from any machine, without using licenses.

How to re-allocate a license?

If you have users which are dormant or no longer use Simscope, you can edit their account and mark as disabled.

API Query

Simscope has a REST API to query the current user/license activity, in JSON format.

This enables querying or can be used to chart activity over time (via Grafana, etc).

Parameters

URL

• GET /api/config/license-activity?lookback=60m

• lookback — determines which period to check user activity in (60m = 60 minutes).

  • For example, set to 30d to see how many unique users in Simscope in the past 30 days.

• Note: this API requires an API token to access from a script.

Example JSON response

{
    "lookback": "2022-09-10T13:37:36.159233-05:00",
    "seats_total": 50,
    "seats_used": 8,
    "seats_available": 42,
    "users_active": 5,
    "users": [
        "admin",
        "fred",
        "jenny",
        "lisa.simpson",
        "pdq"
    ]
}

This example indicates:

• 50 licensed seats
• 8 seats used
  • 42 seats available (ie remaining)
• 5 unique users active (in the last 60 minutes)