This Method is used to modify a user in the user management of the Server.
If the UserConfiguration bit Disabled is changed to TRUE, all Sessions and Subscriptions associated with the disabled user shall be closed by the Server. If the user of the Session used to call the Method is to be disabled, the Method shall fail with Bad_InvalidSelfReference.
The Client shall use an encrypted channel and shall provide user credentials with administrator rights like SecurityAdmin Role when invoking this Method on the Server.
Signature
ModifyUser (
[in]String UserName,
[in]Boolean ModifyPassword,
[in]String Password,
[in]Boolean ModifyUserConfiguration,
[in]UserConfigurationMaskUserConfiguration,
[in]Boolean ModifyDescription,
[in]String Description
);
|
Argument |
Description |
|
UserName |
The name of the user to modify. |
|
ModifyPassword |
Flag indicating if the password should be changed. |
|
Password |
The password for the user. The password is set to a null or empty string if ModifyPassword is false. The argument is ignored if ModifyPassword is false. |
|
ModifyUserConfiguration |
Flag indicating if the user configuration should be changed. |
|
UserConfiguration |
The configuration mask for the user. The argument is ignored if ModifyUserConfiguration is false. |
|
ModifyDescription |
Flag indicating if the user description should be changed. |
|
Description |
A description for the user. The argument is ignored if ModifyDescription is false. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_NotFound |
The user was not found in the user management. |
|
Bad_OutOfRange |
The password is outside the valid range of accepted length and characters. |
|
Bad_NotSupported |
The UserConfiguration has flags set that are not supported by the Server. See PasswordOptions for flags supported by the Server. |
|
Bad_ConfigurationError |
The UserConfiguration has invalid combinations of flags set. |
|
Bad_UserAccessDenied |
The caller does not have the necessary Permissions. |
|
Bad_SecurityModeInsufficient |
The communication channel is not using encryption. |
|
Bad_InvalidSelfReference |
The user to be disabled is the user of the Session calling the Method. |
The ModifyUser Method representation in the AddressSpace is formally defined in Table 29.
Table 29 – ModifyUser Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
ModifyUser |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
M |
|
ConformanceUnits |
|||||
|
Security User Management Server |
|||||