Get Licenses

Get

/api/v1/licenses.info

Retrieves a list of all registered licenses and the details in the workspace.

Permission required: view-privileged-setting.

The licenses.isEnterprise and licenses.get endpoints have been removed from 7.0. Use this endpoint instead.

Header parameters

X-Auth-Token

stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f

X-User-Id

stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Responses

200

Success Example

{
  "license": {
    "license": {
      "version": "3.0",
      "information": {
        "id": "6569155ab286e50001b78ec1",
        "autoRenew": true,
        "createdAt": "2024-03-17T00:51:43.529361607Z",
        "visualExpiration": "2024-03-10T00:00:00Z",
        "notifyAdminsAt": "2024-03-10T00:00:00Z",
        "notifyUsersAt": "2024-03-10T00:00:00Z",
        "trial": true,
        "cancellable": true,
        "offline": false,
        "grantedBy": {},
        "grantedTo": {},
        "tags": [
          {
            "name": "Enterprise trial",
            "color": "#F3BE08"
          }
        ]
      },
      "validation": {
        "serverUrls": [
          {
            "value": "testspace.rocket.chat",
            "type": "url"
          }
        ],
        "cloudWorkspaceId": "64df890111e1f20001d201b4",
        "serverUniqueId": "tgxSuzXmWe68S3kWR",
        "validPeriods": [
          {
            "validUntil": "2024-03-24T00:00:00Z",
            "invalidBehavior": "invalidate_license"
          }
        ],
        "legalTextAgreement": {
          "type": "required",
          "acceptedVia": "cloud"
        },
        "statisticsReport": {
          "required": true,
          "allowedStaleInDays": 2
        }
      },
      "grantedModules": [
        {
          "module": "auditing"
        },
        {
          "module": "canned-responses"
        },
        {
          "module": "ldap-enterprise"
        },
        {
          "module": "livechat-enterprise"
        },
        {
          "module": "voip-enterprise"
        },
        {
          "module": "omnichannel-mobile-enterprise"
        },
        {
          "module": "engagement-dashboard"
        },
        {
          "module": "push-privacy"
        },
        {
          "module": "scalability"
        },
        {
          "module": "teams-mention"
        },
        {
          "module": "saml-enterprise"
        },
        {
          "module": "oauth-enterprise"
        },
        {
          "module": "device-management"
        },
        {
          "module": "federation"
        },
        {
          "module": "videoconference-enterprise"
        },
        {
          "module": "message-read-receipt"
        },
        {
          "module": "outlook-calendar"
        },
        {
          "module": "hide-watermark"
        },
        {
          "module": "custom-roles"
        },
        {
          "module": "accessibility-certification"
        }
      ],
      "limits": {
        "guestUsers": [
          {
            "max": 235,
            "behavior": "start_fair_policy"
          },
          {
            "max": 235,
            "behavior": "prevent_action"
          }
        ],
        "roomsPerGuest": [
          {
            "max": 1,
            "behavior": "start_fair_policy"
          },
          {
            "max": 1,
            "behavior": "prevent_action"
          }
        ],
        "monthlyActiveContacts": [
          {
            "max": -1,
            "behavior": "start_fair_policy"
          },
          {
            "max": -1,
            "behavior": "prevent_action"
          }
        ]
      },
      "cloudMeta": {}
    },
    "activeModules": [
      "auditing",
      "canned-responses",
      "ldap-enterprise",
      "livechat-enterprise",
      "voip-enterprise",
      "omnichannel-mobile-enterprise",
      "engagement-dashboard",
      "push-privacy",
      "scalability",
      "teams-mention",
      "saml-enterprise",
      "oauth-enterprise",
      "device-management",
      "federation",
      "videoconference-enterprise",
      "message-read-receipt",
      "outlook-calendar",
      "hide-watermark",
      "custom-roles",
      "accessibility-certification"
    ],
    "preventedActions": {
      "activeUsers": false,
      "guestUsers": false,
      "roomsPerGuest": false,
      "privateApps": false,
      "marketplaceApps": false,
      "monthlyActiveContacts": false
    },
    "limits": {
      "activeUsers": {
        "max": -1
      },
      "guestUsers": {
        "max": 235
      },
      "privateApps": {
        "max": -1
      },
      "marketplaceApps": {
        "max": -1
      },
      "monthlyActiveContacts": {
        "max": -1
      }
    },
    "tags": [
      {
        "name": "Enterprise trial",
        "color": "#F3BE08"
      }
    ],
    "trial": true
  },
  "success": true
}

Expand All

object

license

object

license

object

version

string

information

object

string

autoRenew

boolean

createdAt

string

visualExpiration

string

notifyAdminsAt

string

notifyUsersAt

string

trial

boolean

cancellable

boolean

offline

boolean

grantedBy

object

grantedTo

object