OpenLM Server 4.5 API changes
Deprecation note: SOAP methods are no longer supported on OpenLM Server v5.x.
New Methods
| Name | Request / Response | Description |
| AnonymizeUser | AnonymizeUserRequest | GDPR Anonimises user data from the system |
| ResetLicenseFileCalculationTime | RecalculateLicenseFileRequest | Enforce immediate calculation of license file |
| GetFullLoggingSettings | BaseRequest | Returns full logging settings of general and specific license servers logs and their full logging due date. |
| GetTokenFlexVendors | BaseRequest | Returns all vendors support TokenFlex |
| GetTokenFlexStructure | TokenFlexStructureRequest | Returns License Servers, Families and Features by vendor supports TokenFlex |
| ResetTokenFlexTree | ResetTokenFlexTreeRequest | Resets Families and Features assigned, of vendor supports TokenFlex |
| UpdateTokenFlexStructure | UpdateTokenFlexStructureRequest | Updates Families and Features of vendor supports TokenFlex |
| AddTokenFlexProductFamily | UpdateTokenFlexProductFamilyRequest | Adds Product Family for TokenFlex based vendor |
| UpdateTokenFlexProductFamily | UpdateTokenFlexProductFamilyRequest | Updates Product Family of TokenFlex based vendor |
| DeleteTokenFlexProductFamily | DeleteTokenFlexProductFamilyRequest | DeletesProduct Family of TokenFlex based vendor |
| UpdateTokenFlexTokensSettings | UpdateTokenFlexTokensSettingsRequest | Updates Token Settings (Grace Time) of TokenFlex based vendor |
| UpdateTokenRates | UpdateTokenRatesRequest | Updates Familes’ Token Rates of a TokenFlex based vendor |
| ExportTokenFlexProductsFamilies | ExportTokenFlexProductsFamiliesRequest | Exports TokenFlex Products Familes |
| UpdateTokenFlexProductsDefaultFamilies | UpdateTokenFlexProductsDefaultFamiliesRequest | Updates TokenFlex Product Default Families |
| GetTokenFlexLicenseServers | TokenFlexLicenseServersRequest | Returns License Servers that support TokenFlex |
| GetTokenFlexUsage | TokenFlexUsageRequest | Returns usage of TokenFlex families and features |
| ChangePassword | ChangePasswordRequest | Change password by user |
| ResetPassword | ResetPasswordRequest | Reset user password |
| GetEmailSettingsTestResult | BaseRequest | Gets result of last email settings test |
| GetTokenFlexDoubleConsumption | TokenFlexDoubleConsumptionRequest | Returns double consumption of TokeFlex features |
| UpdateDefaultTimeZoneSettings | UpdateDefaultTimeZoneSettingRequest | Updates default time zone settings |
| GetEmailNotificationsSettings | BaseRequest | Get Email Notifications Settings |
| UpdateEmailNotificationsSettings | UpdateEmailNotificationsSettingsRequest | Update Email Notifications Settings |
| ImportUsers | ImportUsersRequest
ImportUsersResponse |
Import users from file |
| GetVendorDistinctFamilies | GetVendorDistinctFamiliesRequest | Returns Families of TokenFlex vendor |
| AddUserEmail | AddUserEmailRequest | Add email to user missing email address |
| CheckVerificationCode | CheckVerificationCodeRequest
UserAuthenticationResponse |
Verify verificationCode the user user enters |
| CheckStrongPasswordOn | BaseRequest | Check if strong password is on |
| CheckUser | UserAuthenticationRequest | Check username for two phase authentication |
| GetDefaultTimeZoneSettings | BaseRequest
DefaultTimeZoneSettingsResponse |
Get default time zone settings |
| GetLicenseServersList | BaseRequest
LicenseServersListResponse |
Returns List of license servers |
| GetAllSecuritySettings | BaseRequest
SecuritySettingsResponse |
Returns all security settings |
| UpdateSecuritySettings | UpdateSecuritySettingsRequest | Update security settings |
| SendSupportSummaryReport | SendSupportSummaryReportRequest | Send Support Summary Report by email |
| SetLoggerConfigFile | SetLoggerConfigFileRequest | Set logger config file |
| SetAdmin | SetAdminRequest
SetAdminResponse |
Set admin user |
New Classes
AnonymizeUserRequest
| Property | Type | Description |
| UserID | Int32 | ID of user to anonimize |
RecalculateLicenseFileRequest
| Property | Type | Description |
| ServerId | Int32 | An ID of License Server |
FullLoggingSettingsResponse
| Property | Type | Description |
| IsGeneralFullLoggingOn | Boolean | Whether general full logging is set |
| LoggerConfigFile | String | The location of logging configuration file |
| GeneralFullLoggingDueDate | SlimDateTime | The date when general full logging ends |
| LMServersFullLoggingDueDates | ServerFullLoggingDueDate[] | The dates of License Servers full logging end. |
ServerFullLoggingDueDate
| Property | Type | Description |
| ServerId | Int32 | ID of License Server |
| ServerDescription | String | The description of License Server |
| DueDate | SlimDateTime | The date when full logging ends |
TokenFlexVendorsResponse
| Property | Type | Description |
| TokenFlexVendors | TokenFlexVendor[] | The list of TokenFlex vendors |
TokenFlexVendor
| Property | Type | Description |
| VendorName | String | The name of TokenFlex vendor |
| Description | String | The description of TokenFlex vednor |
| IsInitialized | Boolean | Whether TokenFlex wizard was completed for vendor |
| GraceTime | Int32 | The grace time in minutes |
| DefaultFamiliesURL | String | The URL of default families update file |
TokenFlexStructureRequest
| Property | Type | Description |
| Vendor | String | The name of TokenFlex vendor |
| ExcludeFamiliesFeatures | Boolean | Whether to exclude families’ features in the response |
TokenFlexStructureResponse
| Property | Type | Description |
| LicenseServers | TokenFlexLicenseServer[] | A list of TokenFlex License Servers |
| ProductFamilies | TokenFlexProductFamily[] | A list of TokenFlex Product Families and Features |
ResetTokenFlexTreeRequest
| Property | Type | Description |
| Vendor | String | The name of TokenFlex vendor |
GetVendorDistinctFamiliesRequest
| Property | Type | Description |
| Vendor | String | The name of TokenFlex vendor |
VendorDistinctFamiliesResponse
| Property | Type | Description |
| Families | TokenFlexDistinctFamily[] | A list of families |
TokenFlexDistinctFamily
| Property | Type | Description |
| FamilyName | String | The name of family |
| DeprecatedDate | SlimDateTime | A date when family was deprected |
UpdateTokenFlexStructureRequest
| Property | Type | Description |
| Vendor | String | The name of TokenFlex vendor |
| GraceTime | Int32 | The grace time in minutes |
| AddedProductFamilies | TokenFlexProductFamily[] | A list of added product families |
| UpdatedProductFamilies | TokenFlexProductFamily[] | A list of updated product families |
| DeletedProductFamilies | Int32[] | A list of IDs of deleted product families |
TokenFlexProductFamily
| Property | Type | Description |
| ID | String | An ID of family |
| GraceTime | Int32 | A grace time in minutes |
| FamilyName | String | A name of family |
| Vendor | String | A name of vendor |
| TokenRate | Int32 | A token rate of family |
| IsDefault | Boolean | Whether the family is default or custom |
| IsUnassigned | Boolean | Whether the family is “Unassigned” family |
| IsPending | Boolean | Whether the family was changed |
| Features | TokenFlexProductFamilyFeature[] | List of features |
TokenFlexProductFamilyFeature
| Property | Type | Description |
| ID | String | An ID of feature |
| FeatureName | String | A name of feature |
| IsPending | Boolean | Whether feature was changed |
UpdateTokenFlexProductFamilyRequest
| Property | Type | Description |
| Vendor | String | A name of vendor |
| ProductFamily | TokenFlexProductFamily | A product family |
DeleteTokenFlexProductFamilyRequest
| Property | Type | Description |
| Vendor | String | A name of vendor |
| ProductFamilyID | Int32 | An ID of product family |
UpdateTokenFlexProductFamilyResponse
| Property | Type | Description |
| UpdatedFamily | TokenFlexProductFamily | An updated family |
UpdateTokenFlexTokensSettingsRequest
| Property | Type | Description |
| Vendor | String | A name of vendor |
| GraceTime | Int32 | A grace time in minutes |
UpdateTokenRatesRequest
| Property | Type | Description |
| Vendor | String | A name of vendor |
| ProductFamilesTokenRates | ProductFamilyTokenRate[] | A list of token rates per product family |
ProductFamilyTokenRate
| Property | Type | Description |
| FamilyID | Int32 | An ID of family |
| TokenRate | Int32 | A token rate |
UpdateTokenRatesResponse
| Property | Type | Description |
| FamiliesIDs | UpdatedFamilyID[] | A list of Families IDs |
UpdatedFamilyID
| Property | Type | Description |
| OldID | Int32 | A previous ID |
| NewID | Int32 | An updated ID |
ExportTokenFlexProductsFamiliesRequest
| Property | Type | Description |
| Vendor | String | A name of vendor |
UpdateTokenFlexProductsDefaultFamiliesRequest
| Property | Type | Description |
| Vendor | String | A name of vendor |
| FileContent | String | A file content of updated default families |
| IsOnlineUpdate | Boolean | Whether the file update is online or offline |
TokenFlexLicenseServersRequest
| Property | Type | Description |
| Vendor | String | A name of vendor |
TokenFlexLicenseServersResponse
| Property | Type | Description |
| LicenseServers | TokenFlexLicenseServer[] | A list of TokenFlex License Servers |
TokenFlexLicenseServer
| Property | Type | Description |
| ID | Int32 | An ID of License Server |
| Name | String | A description of License Server |
| Enabled | Boolean | Whether License Server monitoring is enabled |
| ServerSideSampling | Boolean | Whether a License Server is monitored by OpenLM Server or OpenLM Broker |
TokenFlexUsageRequest
| Property | Type | Description |
| Vendor | String | A name of vendor |
| LicenseServersIDs | Int32 | A list of License Servers IDs |
| Families | String[] | A list of Families names |
| UserIDs | Int32[] | A list of user IDs |
| GroupByType | TokenFlexGroupByType | Type of group by, the values are: Family or User |
| GroupByPeriod | TokenFlexGroupByPeriod | Group By Period, the values are:
Off, Day, Week, Month, Year |
| StartDate | SlimDateTime | A start date of usage |
| EndDate | SlimDateTime | An end date of usage |
| IsChart | Boolean | Whether chart or table data to be retrieved |
| ChartType | TokenFlexUsageChartType | Type of chart, the values are:
MostExpensive, MostUsed |
TokenFlexUsageResponse
| Property | Type | Description |
| Usages | TokenFlexAggregatedUsage[] | A list of token flex usages per page size |
| TotalCount | Int32 | A total count of usages |
TokenFlexAggregatedUsage
| Property | Type | Description |
| Vendor | String | A name of vendor |
| ProductFamilyName | String | A name of product family |
| ConsumptionTime | Int64 | A number of seconds the tokens were consumed |
| Tokens | Int64 | A number of tokens consumed |
| UserName | String | A username |
| FirstName | String | User first name |
| LastName | String | User last name |
| String | User email | |
| GroupByPeriod | String | The usage period range |
| DeprecatedDate | SlimDateTime | A date when family was deprecated |
TokenFlexDoubleConsumptionRequest
| Property | Type | Description |
| Vendor | String | A name of vendor |
| LicenseServersIDs | Int32[] | A list of license servers IDs |
| UserIDs | Int32[] | A list of users IDs |
| StartDate | SlimDateTime | A start date of double consumption |
| EndDate | SlimDateTime | An end date of double consumption |
| ReccurencePercentage | Int32 | A recurrence percentage |
TokenFlexDoubleConsumptionResponse
| Property | Type | Description |
| DoubleConsumptions | TokenFlexDoubleConsumption[] | A list of double consumptions per page size |
| TotalCount | Int32[] | A total number of consumptions |
TokenFlexDoubleConsumptionResponse
| Property | Type | Description |
| DoubleConsumptions | TokenFlexDoubleConsumption[] | A list of double consumptions per page size |
| TotalCount | Int32[] | A total number of consumptions |
ChangePasswordRequest
| Property | Type | Description |
| UserName | String | |
| OldPassword | String | |
| NewPassword | String | |
| IsInitial | Boolean | Is it first login when the user doesn’t have a password |
ResetPasswordRequest
| Property | Type | Description |
| UserName | String | User to reset the password for |
ResetPasswordResponse
| Property | Type | Description |
| Message | String | Message to display if needed |
| Status | Boolean | Is action succeed |
ResultResponse
| Property | Type | Description |
| Status | Boolean | Is action succeed |
UpdateDefaultTimeZoneSettingRequest
| Property | Type | Description |
| UseDefaultTimeZoneSetting | Boolean | |
| DefaultTimeZoneSetting | String |
EmailNotificationsSettingsResponse
| Property | Type | Description |
| EmailNotification | Boolean | Do we send email for notifications |
| PerformanceImprovement | Boolean | Do we send notifications’ email for performance improvement |
| LicenseViolations | Boolean | Do we send notifications’ email for license violations |
| CheckServerUpdates | Boolean | Do we send notifications’ email for new OpenLM server version |
| UsabilityReport | Boolean | Do we send notifications’ email for usability report |
PortCommandConfig
| Property | Type | Description |
| Command | BrokerCommands (Enum Int32) | A command in OpenLM Broker configuration.
The options are: stop = 4, reread = 5 |
| IsEnabled | Boolean | Whether the command is enabled in OpenLM Broker configuration |
UserResponse
| Property | Type | Description |
| Check | String | OK when the request is legal |
| AuthenticationID | String | Guid when a legal user found. Empty if user not found |
CheckVerificationCodeRequest
| Property | Type | Description |
| AuthenticationID | String | |
| VerificationCode | String |
AddUserEmailRequest
| Property | Type | Description |
| AuthenticationID | String | As returned from the authentication request |
| String | The email to add to the user. A verification code will be sent to this email. A request to the CheckVerificationCode API must be performed with the verification code sent, to complete authentication. |
Changed Methods
| Name | Request / Response | Description |
| PerformUserAuthentication | UserAuthenticationRequest
UserAuthenticationResponse |
Perform authentication |
New error codes for PerformUserAuthentication method:
| Code | Error | Description |
| 17 | IncorrectUsername | User name didn’t exist on DB |
| 18 | UserBlocked | User blocked after reaching max wrong password attempts twice (On first time the user is temporarily blocked). Only the admin can release the user. |
| 19 | PasswordExpired | Password expired. User must cahnge password. |
| 20 | PasswordCreated | Password created for the user, and sent to him by email. |
| 21 | UserTemporaryBlocked | User temporary blocked after reaching max wrong password attempts. The user can try login again in 15 minutes. |
| 22 | LoginFailedLastTry | Login failed with the wrong password. If the next attempt will also fail with the wrong password, the user will be blocked. |
| 23 | MissingEmail | Login failed because this user email isn’t configured, and no password set for this user. Only admin can add email & reset the password for the user. |
| 25 | EmailSettingsNotConfiguredClient | If WebAuthentication is false SMTP settings must be set before trying authentication. |
| 26 | ChangeEmail | Authentication was successful, but the profile is missing the email, a request to AddUserEmail must be done using the AuthenticationID returned from this request |
| 32 | PasswordError | Login failed with the wrong password. |
Changed Classes
LicenseUsageReportRequest
Used in GetLicenseUsageReport API
| Property | Type | Description |
| ExcludedWorkstations | String[] | Added – Workstations to be excluded |
CurrentlyConsumedLicensesRequest
Used in GetCurrentlyConsumedLicenses API
| Property | Type | Description |
| Workstations | String | Added – Workstations list to filter by |
CurrentlyConsumedLicenses
Used in GetCurrentlyConsumedLicenses API
| Property | Type | Description |
| AgentUserLastHearbeat | SlimDateTime | Added – Last time Agent User reported |
| IsAgentUserOnline | Boolean | Added – Indication whether agent user is online |
LicenseServerHostDetails
Used in GetCurrentlyConsumedLicenses API
| Property | Type | Description |
| ConfiguredCommands | PortCommandConfig[] | Added – A list of commands configurations in OpenLM Broker |
UserAuthenticationRequest
Used in PerformUserAuthentication API
| Property | Type | Description |
| TwoPhaseAuthentication | Boolean | Added – |
| WebAuthentication | Boolean | Added – |
| AuthenticationID | String | Added – |
Common Classes
BaseRequest
Property |
Type |
Description |
| BaseInfo | RequestBaseInfo | General request information includes: Session, Paging, User local settings, etc. |
RequestBaseInfo
| Property | Type | Description |
| SessionData | SessionRefresh | Session Data |
| PagingData | PagingData | Paging Data |
| UserLocalSettings | UserLocalSettings | User localization settings:
Date time format, timezone and etc. |
| IsExport | Boolean | Whether to get exported to csv results |
| CustomerId | String | Customer’s identifier Relevant to SAAS system only. |
SessionRefresh
Property |
Type |
Description |
| SessionID | String | The ID of session |
| Refresh | Boolean | Is manual refresh |
PagingData
UserLocalSettings
BaseResponse
Property |
Type |
Description |
| SaasToken | String | An authentication session ID in SaaS mode. |
| Error | Error | Error data (if error exists) |
| ExportString | String | The export response (if export requested) |
| ExportContentType | ExportContentType | The content type of export:
Text or URL |
Error
Property |
Type |
Description |
| Code | Int32 | The error code |
| Message | String | The error message |
| Parameters | KeyValueStringPair[] | A list of error parameters |
KeyValueStringPair
Property |
Type |
Description |
| Key | String | The key of pair |
| Value | String | The value of pair |
SlimDateTime
| Property | Type | Description |
| Year | Int32 | |
| Month | Int32 | |
| Day | Int32 | |
| Hour | Int32 | |
| Minute | Int32 | |
| Second | Int32 |
Enumeration Classes
ExportContentType
| Name | Value | Description |
| Text | 0 | Export Text |
| Link | 1 | Export File URL |