UserAccount Type
A container for user account information.
Remarks
UserAccount objects are used to store user account information, such as logins and passwords.
Fields
AssociatedData ByteArray? |
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. | |||||||||
BasePath String? |
Base path for this user in the server's file system. | |||||||||
Cert ByteArray? |
Contains the user's certificate. | |||||||||
Data String? |
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. | |||||||||
HashAlgorithm String? |
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:
| |||||||||
IncomingSpeedLimit Int |
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation". | |||||||||
OtpAlgorithm OTPAlgorithms |
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.
| |||||||||
OtpValue Int |
The user's time interval (TOTP) or Counter (HOTP). | |||||||||
OutgoingSpeedLimit Int |
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation". | |||||||||
Password String? |
The user's authentication password. | |||||||||
PasswordLen Int |
Specifies the length of the user's OTP password. | |||||||||
SharedSecret ByteArray? |
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. | |||||||||
SSHKey ByteArray? |
Contains the user's SSH key. | |||||||||
Username String? |
The registered name (login) of the user. |
Constructors
public constructor()
Creates a new UserAccount object.