Click here to view and discuss this page in DocCommentXchange. In the future, you will be sent there automatically.

SAP SQL Anywhere, on-demand edition 1.0 SP 6 » Task syntax

AlterUser task

Alters user properties.

Syntax 1 (SQL)
CALL DBCloud.AlterUser ( user=user [, optional-parameters ] )
Syntax 2 (Cloud Command utility)
dbcloudcmd run AlterUser user [ optional-parameters ]
Parameters
  • user

    The user to be altered. Accepts a search query that identifies one user, for example a user name or ID. (Required)

  • password

    The password for the user. The default is the current value.

  • user_privileges

    A comma-delimited list of privileges for the user. To create an Administrator, specify Administrator. The default is the current value.

  • full_name

    The user's display name in the Cloud Console. The default is the current value.

  • email_address

    The email address of the user. The default is the current value.

  • description

  • object_etag

    Internal use only. The default is NULL.

  • object_updated

    The last time the object was modified. If provided, the task fails if the object has changed since the specified time. The default is NULL.The description of the user, in quotes. The default is the current value.

  • web_console_preferences

    Internal use only. The web_console_preferences parameter stores Console-specific user preferences. The default is NULL.

Conditional privileges

CreateDropUser, ManageUserPrivilege, DelegatePrivilege

Remarks

Any user can change their own description, password, full name, or email address.

The description of the user, in quotes. The defaultTo change another user's password, full name, or email address, you must have CreateDropUser privilege.

Changing a user's privileges replaces their privileges. To change a user's privileges, you must have either of the ManageUserPrivilege or DelegatePrivilege privileges, combined with the privilege you want to grant.

To create a cloud Administrator, specify Administrator in the user_privileges field.

To ensure that you are not over-writing another user's changes, run dbcloudcmd -v describe task to get the time the cloud was last modified. Specify this value as the object_updated parameter. If the cloud has been altered since the specified time, then the task fails with an error. If this occurs, run the task again after re-running dbcloudcmd -v describe task.

Example

The following command changes JSmith's password:

dbcloudcmd run AlterUser user=JSmith password=p3fk

The following command changes John Smith's email address, but does not alter his password.

dbcloudcmd run AlterUser user=JSmith email_address="jsmith@companyemail.com"

The following command changes John Smith's privileges:

dbcloudcmd run AlterUser user=JSmith user_privileges="AddDatabase,DropDatabase"