Edit

Database.SetUserPassword(Guid, Text) Method

  • Article

Version: Available or changed with runtime version 1.0.

Sets a password for the user iwith the given user security ID. If the given password is blank, an empty string will be stored instead of a password hash. This will prevent the user from logging in using a password. Only SUPER can call this method. Passwords cannot be set for the empty GUID or for the default Super ID.

Note

This method is supported only in Business Central on-premises.

Syntax

[Ok := ]  Database.SetUserPassword(USID: Guid, Password: Text)

Note

This method can be invoked without specifying the data type name.

Parameters

USID
 Type: Guid
User security ID of the user for which to set the password.

Password
 Type: Text
The password to set for the user.

Return Value

[Optional] Ok
 Type: Boolean
true if the operation was successful; otherwise false. If you omit this optional return value and the operation does not execute successfully, a runtime error will occur.

See Also

Database Data Type
Get Started with AL
Developing Extensions