Classes
Methods
# async assignLicenceToUser(licenceids, userid) → {Promise.<ApiResponse>}
Assign a licence to a user
Parameters:
| Name | Type | Description |
|---|---|---|
licenceids |
Array.<string>
|
The licence IDs |
userid |
string
|
The user ID |
- Since:
- 09.2025, aab
message
Promise.<ApiResponse>
# async createLicence(licence_data) → {Promise.<ApiResponse>}
Create a licence
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
licence_data |
object
|
The licence data |
|
contract |
string
|
<optional> |
The contract |
licencee |
string
|
<optional> |
The licencee |
scope |
string
|
<optional> |
The scope |
module |
string
|
<optional> |
The module |
maxpermissions |
string
|
<optional> |
The max permissions |
maxseats |
string
|
<optional> |
The max seats |
startdate |
string
|
<optional> |
The start date |
expirated |
string
|
<optional> |
The expirated date |
- Since:
- 09.2025, aab
Licence
Promise.<ApiResponse>
# async deleteLicence(licenceid) → {Promise.<ApiResponse>}
Delete a licence
Parameters:
| Name | Type | Description |
|---|---|---|
licenceid |
string
|
The licence ID |
- Since:
- 09.2025, aab
message
Promise.<ApiResponse>
# async getLicenceById(licenceid) → {Promise.<ApiResponse>}
Get a licence by ID
Parameters:
| Name | Type | Description |
|---|---|---|
licenceid |
string
|
The licence ID |
- Since:
- 09.2025, aab
Licence
Promise.<ApiResponse>
# async getLicences(filters) → {Promise.<ApiResponse>}
List licences with optional filters (all can be combined). like
const licences = await LicenceServices.getLicences({ scope: 'cn_dv', module: 'objecttypes', contract: 'contract_1', licencee: 'licencee_1', licence: 'licence_1' });
Parameters:
| Name | Type | Description |
|---|---|---|
filters |
Record.<string, string>
|
The filters |
- Since:
- 09.2025, aab
Licence
Promise.<ApiResponse>
# async getLicencesOfUser(userid) → {Promise.<ApiResponse>}
Get licences of a user
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
string
|
The user ID |
- Since:
- 09.2025, aab
Licence
Promise.<ApiResponse>
# async unassignLicenceFromUser(licenceid, userid) → {Promise.<ApiResponse>}
Unassign a licence from a user
Parameters:
| Name | Type | Description |
|---|---|---|
licenceid |
string
|
The licence ID |
userid |
string
|
The user ID |
- Since:
- 09.2025, aab
message
Promise.<ApiResponse>
# async updateLicence(licenceid, licence_data) → {Promise.<ApiResponse>}
Update a licence
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
licenceid |
string
|
The licence ID |
|
licence_data |
object
|
The licence data |
|
contract |
string
|
<optional> |
The contract |
licencee |
string
|
<optional> |
The licencee |
scope |
string
|
<optional> |
The scope |
module |
string
|
<optional> |
The module |
maxpermissions |
string
|
<optional> |
The max permissions |
maxseats |
string
|
<optional> |
The max seats |
startdate |
string
|
<optional> |
The start date |
expirated |
string
|
<optional> |
The expirated date |
- Since:
- 09.2025, aab
Licence
Promise.<ApiResponse>