Licensing

Version 5.1 by michaely on 2016/05/29 15:07

For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

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

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.

On this page:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Root Resource Path

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

JSON Representation

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

Property	Type	Description
id	String	Configuration id of the license.
serial	String	The serial key of the license.
expirationDate	Long	The expiration date of the license. Represented as a Unix timestamp in milliseconds. Set to null if the license does not expire.
maintenanceExpirationDate	Long	The maintenance expiration date of the license. Represented as a Unix timestamp in milliseconds.
clientConnections	Integer	The number of concurrent client logins allowed. -1 allows infinite logings. This is not currently used by the licensing system.
configuredUsers	Integer	The 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

Description

Accesses 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

Description

Allows activation of a license on a core server instance.

POST

Activates a license on the core server instance.

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:

{
"cancel": false,
"licensedTo": "Michael Yara",
"email": "me@mydomain.com"
}

Property	Type	Description
cancel	Boolean	Set to true if you wish to cancle the bind request. Normally you will have this set to false.
licensedTo	String	The name of the person or company name that owns the license.
email	String	The 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.

Curl Examples

Get the license for the core server

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

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

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.