UserManager Component

Properties   Methods   Events   Config Settings   Errors  

The UserManager component stores information about user accounts.

Syntax

TsbxUserManager

Remarks

UserManager is responsible for storing, importing, and exporting information about users. It is primarily used with the server components.

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

FIPSMode Property (UserManager Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

UserCount Property (UserManager Component)

The number of records in the User arrays.

Syntax

__property int UserCount = { read=FUserCount, write=FSetUserCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCertificate
• UserData
• UserEmail
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOtpAlgorithm
• UserOTPLen
• UserOtpValue
• UserOutgoingSpeedLimit
• UserPassword
• UserSharedSecret
• UserSSHKey
• UserUsername

The array indices start at 0 and end at UserCount - 1.

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (UserManager Component)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

__property DynamicArray UserAssociatedData[int UserIndex] = { read=FUserAssociatedData, write=FSetUserAssociatedData };

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (UserManager Component)

Base path for this user in the server's file system.

Syntax

__property String UserBasePath[int UserIndex] = { read=FUserBasePath, write=FSetUserBasePath };

Default Value

""

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserCertificate Property (UserManager Component)

Contains the user's certificate.

Syntax

__property DynamicArray UserCertificate[int UserIndex] = { read=FUserCertificate, write=FSetUserCertificate };

Remarks

Contains the user's certificate.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserData Property (UserManager Component)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

__property String UserData[int UserIndex] = { read=FUserData, write=FSetUserData };

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserEmail Property (UserManager Component)

The user's email address.

Syntax

__property String UserEmail[int UserIndex] = { read=FUserEmail, write=FSetUserEmail };

Default Value

""

Remarks

The user's email address.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserHandle Property (UserManager Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 UserHandle[int UserIndex] = { read=FUserHandle, write=FSetUserHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (UserManager Component)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

__property String UserHashAlgorithm[int UserIndex] = { read=FUserHashAlgorithm, write=FSetUserHashAlgorithm };

Default Value

""

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (UserManager Component)

Specifies the incoming speed limit for this user.

Syntax

__property int UserIncomingSpeedLimit[int UserIndex] = { read=FUserIncomingSpeedLimit, write=FSetUserIncomingSpeedLimit };

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOtpAlgorithm Property (UserManager Component)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Syntax

__property TsbxUserManagerUserOtpAlgorithms UserOtpAlgorithm[int UserIndex] = { read=FUserOtpAlgorithm, write=FSetUserOtpAlgorithm };

enum TsbxUserManagerUserOtpAlgorithms {
  oaNone=0,
  oaHmac=1,
  oaTime=2
};

Default Value

oaNone

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOTPLen Property (UserManager Component)

Specifies the length of the user's OTP password.

Syntax

__property int UserOTPLen[int UserIndex] = { read=FUserOTPLen, write=FSetUserOTPLen };

Default Value

0

Remarks

Specifies the length of the user's OTP password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOtpValue Property (UserManager Component)

The user's time interval (TOTP) or Counter (HOTP).

Syntax

__property int UserOtpValue[int UserIndex] = { read=FUserOtpValue, write=FSetUserOtpValue };

Default Value

0

Remarks

The user's time interval (TOTP) or Counter (HOTP).

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (UserManager Component)

Specifies the outgoing speed limit for this user.

Syntax

__property int UserOutgoingSpeedLimit[int UserIndex] = { read=FUserOutgoingSpeedLimit, write=FSetUserOutgoingSpeedLimit };

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserPassword Property (UserManager Component)

The user's authentication password.

Syntax

__property String UserPassword[int UserIndex] = { read=FUserPassword, write=FSetUserPassword };

Default Value

""

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserSharedSecret Property (UserManager Component)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

__property DynamicArray UserSharedSecret[int UserIndex] = { read=FUserSharedSecret, write=FSetUserSharedSecret };

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserSSHKey Property (UserManager Component)

Contains the user's SSH key.

Syntax

__property DynamicArray UserSSHKey[int UserIndex] = { read=FUserSSHKey, write=FSetUserSSHKey };

Remarks

Contains the user's SSH key.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (UserManager Component)

The registered name (login) of the user.

Syntax

__property String UserUsername[int UserIndex] = { read=FUserUsername, write=FSetUserUsername };

Default Value

""

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

AddUser Method (UserManager Component)

Creates a new user account and adds it to the Users list.

Syntax

int __fastcall AddUser(String Username);

Remarks

Use this method to create a new user record.

Config Method (UserManager Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateNew Method (UserManager Component)

Creates a new user account database.

Syntax

void __fastcall CreateNew();

Remarks

Use this method to create a new user database. The method empties the Users collection and makes the component ready for editing the new database.

DoAction Method (UserManager Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

ExportBytes Method (UserManager Component)

Saves the user database to a byte array.

Syntax

DynamicArray<Byte> __fastcall ExportBytes(String Password);

Remarks

Use this method to save the settings of all users to a byte array.

Use a non-empty Password to protect the database.

ExportToFile Method (UserManager Component)

Saves the user database to a file.

Syntax

void __fastcall ExportToFile(String FileName, String Password);

Remarks

Use this method to save the settings of all users to a file.

Use a non-empty Password to protect the database.

ExportUser Method (UserManager Component)

Saves the user details to a string.

Syntax

String __fastcall ExportUser(int Index);

Remarks

Use this method to save the details of the user to a string blob.

ImportBytes Method (UserManager Component)

Loads a user database from a byte array.

Syntax

void __fastcall ImportBytes(DynamicArray<Byte> UserBytes, String Password, bool Clear);

Remarks

Use this method to load user information from a byte array specified by UserBytes parameter. Provide a Password to decrypt the user information.

ImportFromFile Method (UserManager Component)

Loads a user database from a file.

Syntax

void __fastcall ImportFromFile(String FileName, String Password, bool Clear);

Remarks

Use this method to load user information from a file specified by FileName. Provide a Password to decrypt the user information.

ImportUser Method (UserManager Component)

Loads a user from a string.

Syntax

int __fastcall ImportUser(String Data);

Remarks

Use this method to load user information from a string specified by Data parameter.

Reset Method (UserManager Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

VerifyUser Method (UserManager Component)

Verifies the correctness of the user credentials.

Syntax

bool __fastcall VerifyUser(String Username, String Password);

Remarks

Use this method to establish the correctness of the supplied username and password.

VerifyUserKey Method (UserManager Component)

Verifies the correctness of the user credentials.

Syntax

bool __fastcall VerifyUserKey(String Username, DynamicArray<Byte> Key);

Remarks

Use this method to establish the correctness of the supplied username and key.

Error Event (UserManager Component)

Reports error information during its work.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxUserManagerErrorEventParams;
typedef void __fastcall (__closure *TsbxUserManagerErrorEvent)(System::TObject* Sender, TsbxUserManagerErrorEventParams *e);
__property TsbxUserManagerErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The event is fired in case of exceptional conditions during user management operations.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (UserManager Component)

This event notifies the application about an underlying control flow event.

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxUserManagerNotificationEventParams;
typedef void __fastcall (__closure *TsbxUserManagerNotificationEvent)(System::TObject* Sender, TsbxUserManagerNotificationEventParams *e);
__property TsbxUserManagerNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (UserManager Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

UserManager Config Settings

Base Config Settings

Trappable Errors (UserManager Component)

UserManager Errors