The Modifying a User call updates an existing Users attributes through parameters to the API.

API Call


http://host/dmadminweb/API/mod/User/User_id

[?param=value]

[&param=value]+


Where:

Host

The hostname and port of the DeployHub Server (e.g.: hostname:8080 or for SaaS console.deployhub.com).

User_id

The ID of the User to be modified. Either its name, its qualified name (i.e.: with its parent Domain(s) included in dot notation) or its internal ID.

Param=value

The User attribute (listed below).


Domain

The identifier of the Domain to which the User is to be moved. Either its name, its qualified name (i.e.: with its parent Domain(s) included in dot notation) or its internal ID.

realname

The User’s real (or full) name

ldap        


The ID of the LDAP Data Source used to authenticate this User (if LDAP authentication is set). If this parameter is not specified, then the User is internally authenticated.

cpw

The Change Password flag (should be Y or N). If present and set to ‘Y’, the User will be required to change their password when they next login (unless password authentication is being handled by LDAP).

tel

The User’s telephone number.

email

The User’s email address.

pw        

The User’s password (ignored if authentication is being done with LDAP).

locked        

The “Account Locked” flag (should be Y or N). If present and set to ‘Y, the User account is “locked” and login is not possible.


Example Result:


{

       success: true

}