Get Maximum Active User

Retrieves a list of the maximum active users.

licenses.maxActiveUsers

Required

GET

Headers

ArgumentExampleRequiredDescription

X-User-Id

myuser-name

Required

The authenticated user ID.

X-Auth-Token

myauth-token

Required

Auth token.

Example Call

curl --location 'http://localhost:3000/api/v1/licenses.maxActiveUsers' \
--header 'x-auth-token: iqJERsuaUgzVSmPMV87RdMThc_yFhK8U5T5mr6Z5CPs' \
--header 'x-user-id: wxnehxdyBPuPyQaNa'

Example Result

Success

{
    "maxActiveUsers": 25,
    "activeUsers": 0,
    "success": true
}

Error

Any of the following errors can occur on the endpoint.

  • Authorization: Requires an authentication token for the request to be made.

{
    "status": "error",
    "message": "You must be logged in to do this."
}

Change Log

VersionDescription

4.0.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.