LicenseResource

LicenseResource REST endpoint to access and manipulate specific licensing data.

Copyright 2013 WANdisco.

The following resources are part of this group:

/license

Mount Point: /api/license

GET

Return license details

Response Body

element: (custom)
media types: application/xml

200 - OK - LicenseDTO

/license/UserAccountCognizance

Mount Point: /api/license/UserAccountCognizance

GET

Return the UserAccountCognizance map which includes the licensed users.

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

/license/reload

Mount Point: /api/license/reload

PUT

Trigger a reload of the license properties (license will be enforced so failure will cause the node to die)

Response Body

element: (custom)
media types: */*
application/xml

200 - OK - license successfully refreshed

/license/updateUserAccountCognizance

Mount Point: /api/license/updateUserAccountCognizance

POST

Updates the user account cognizance

Request Body

element: userAccountCognizance
media types: application/xml

of usernames to licensed user objects

Response Body

element: (custom)
media types: */*
application/xml

202 - ACCEPTED - user account cognizance map updated 400 - BAD REQUEST - see exception

/license/user/{username}

Mount Point: /api/license/user/{username}

DELETE

Delete a user from the license

Parameters

name description type default
username the user to delete path

Response Body

element: (custom)
media types: */*
application/xml

200 - OK - user was deleted 404 - NOT FOUND - the specified user was not found in the licenser

PUT

Add a user to the License map.

Parameters

name description type default
username (no documentation provided) path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)