Cosmic Admin API Reference

updateUser

Updates a user account

Request parameters

Parameter NameDescriptionRequired
idUser uuidtrue
emailemailfalse
firstnamefirst namefalse
lastnamelast namefalse
passwordClear text password (default hashed to SHA256SALT). If you wish to use any other hasing algorithm, you would need to write a custom authentication adapterfalse
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.false
userapikeyThe API key for the user. Must be specified with userSecretKeyfalse
usernameUnique usernamefalse
usersecretkeyThe secret key for the user. Must be specified with userSecretKeyfalse

Response Tags

Response NameDescription
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
iscallerchilddomainthe boolean value representing if the updating target is in caller's child domain
isdefaulttrue if user is default, false otherwise
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name