Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.

Info

The information on this page applies to iSymphony 3.1+.

Description

The license REST resource allows access to the license of a specific core server instance. This resource allows activating licenses.

 

Panel
titleOn this page:

Table of Contents
maxLevel2
indent1
 

Root Resource Path

Code Block
communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license

JSON Representation

Code Block
{
  "id": "8a2632b3-dc9e-4d66-a759-14d347a73b28",
  "serial": "<serial key>",
  "type": "PERPETUAL",
  "licensedTo": "Mike",
  "expirationDate": 1459749600000,
  "maintenanceExpirationDate": 1459749600000,
  "clientConnections": -1,
  "configuredUsers": -1
}
PropertyTypeDescription
id
String

Configuration id of the license.

serialStringThe serial key of the license.
expirationDate
LongThe expiration date of the license. Represented as a Unix timestamp in milliseconds. Set to null if the license does not expire.
maintenanceExpirationDate
LongThe maintenance expiration date of the license. Represented as a Unix timestamp in milliseconds.
clientConnections
IntegerThe number of concurrent client logins allowed. -1 allows infinite logins. This is not currently used by the licensing system.
configuredUsers
IntegerThe number of users allowed to be marked as enabled. -1 allows infinite enabled users. This is not currently used by the licensing system.

Resource Paths

communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license
DescriptionAccesses the license for the core server instance.
GET Gets the license for the core server instance.
 
communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/activate
DescriptionAllows activation of a license on a core server instance.
POST

Activates a license on the core server instance.

Note

If you are binding a license to a new server, this action will return a 403 Temporary Redirect. You need to make another REST call to the URL specified in the Location header of the response, with the additional information to complete the activation. See the bind resource below.

The bind request will timeout after 5 seconds.

Errors:

  • 403: Returned if the license activation was denied.
  • 307: A bind authorization was requested in order to complete the activation.
 
communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/bind/{serial}
Description

Completes a license activation by providing the bind authorization.

Parameters:

  • serial: The serial key of the license to complete the activation for.
POST

Completes a license activation. The following JSON must be passed to the resource:

Code Block
languagejs
{
  "cancel": false,
  "licensedTo": "Michael Yara",
  "email": "me@mydomain.com"
}
PropertyTypeDescription
cancelBooleanSet to true if you wish to cancle the bind request. Normally you will have this set to false.
licensedToStringThe name of the person or company name that owns the license.
emailStringThe email address of the person or company that owns the license.

Errors:

  • 403: Returned if the license activation was denied.

Sub/Child Resource Paths

communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses
Description

Access the sub/child resource for specifics of the license properties for each module in the system.

See Module Licenses for more information.

Curl Examples

Get the license for the core server

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/coreServers/bb8404fb-95b6-474c-b30e-0975283ea692/license

Activate a license

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '<serial>' http://localhost:58080/communication_manager/rest/config/server/coreServers/bb8404fb-95b6-474c-b30e-0975283ea692/license/activate

Replace <serial> with your license serial key. 

Complete a bind authorization

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"cancel": false, "licensedTo": "Michael Yara", "email": "me@mydomain.com"}' http://localhost:58080/communication_manager/rest/config/server/coreServers/bb8404fb-95b6-474c-b30e-0975283ea692/license/bind/<serial>

Replace <serial> with your license serial key.