SoftadminApi.Credentials_UpdateAccount

 Show all Hide all

Updates the secret value held by credentials of type Account.

Used if you build a user interface to let system's users administer its passwords. See the views SoftadminApi.Credentials or SoftadminApi.Credentials_Account for a list of the credentials that users should be allowed to administer.

See also: SoftadminApi.Credentials_UpdateSecret, SoftadminApi.Credentials_InsertUpdate

Account name and password must use the same storage model. You can not, for example, put a username in an application setting and a password in Azure Key Vault.

Type: Stored procedure
Area of use: API

Parameters:

@CredentialsId mandatory uniqueidentifier
ID of credentials to update.
@UserId mandatory int
ID of the user performing the update.
@ClearCache optional bit
If the procedure should output Cache-columns compatible with NewEdit and Execute, so that the old credential values are removed from the cache. The default is 1.
@AccountName optional varchar(300)
Account name, when credentials are stored encrypted in the database.
@AccountPasswordEncrypted optional varchar(max)
Account password, when credentials are stored encrypted in the database. Must be encrypted by a password field with the setting Encrypt as credentials
@AccountNameAppSetting optional varchar(100)
The name of an application setting to read the account name from, when credentials are stored in application settings.
@AccountPasswordAppSetting optional varchar(100)
The name of an application setting to read the password from, when credentials are stored in application settings.
@AccountNameKeyVaultSecret optional varchar(100)
The name of an key vault secret to read the account name from, when credentials are stored in Azure Key Vault.
@AccountPasswordKeyVaultSecret optional varchar(100)
The name of an key vault secret to read the password from, when credentials are stored in Azure Key Vault.