Update

PUT v1/users/id

Description

Modify information about a user.

Normal Response Codes

200

HTTP Error Codes

400 401 404 409 500 503

Detail Error Codes

SM_invalid_arg_value

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_passwd_same_as_current

SM_unexpected_arg

SM_unexpected_query_param

SM_version_name

Request

Parameter	Type	JSON Type	Description	Mandatory	Deprecated
id	NsObjectID	string	Identifier for the user. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.	Yes
name	NsObjectName	string	Name of the user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	No
description	NsDescription	string	Description of the user. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.	No
role	NsUserRoles	string enum	Role of the user. Possible values: 'administrator', 'poweruser', 'operator', 'guest'.	No
password	NsPassword	string	User's login password. String of 8 to 255 printable characters excluding ampersand, backslash and ~;[]`. Example: 'password-91'.	No
auth_password	NsPassword	string	Authorization password for changing password. String of 8 to 255 printable characters excluding ampersand, backslash and ~;[]`. Example: 'password-91'.	No
inactivity_timeout	NsSeconds	number	The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting. Unsigned 64-bit integer. Example: '1234'.	No
full_name	NsFullName	string	Fully qualified name of the user. Alphanumeric string of up to 64 chars, starts with letter, can include space, apostrophe('), hythen(-). Example: 'User-13 Peterson'.	No
email_addr	NsEmail	string	Email address of the user. Case insensitive email address. Example: bob@wikipedia.com.	No
disabled	NsBoolean	boolean	User is currently disabled. Possible values: 'true', 'false'.	No

JSON Request

Response

Parameter	Type	JSON Type	Description	Deprecated
id	NsObjectID	string	Identifier for the user. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
name	NsObjectName	string	Name of the user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
search_name	NsSearchName	string	Name of the user used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.
description	NsDescription	string	Description of the user. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.
role_id	NsObjectID	string	Identifier for the user's role. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
role	NsUserRoles	string enum	Role of the user. Possible values: 'administrator', 'poweruser', 'operator', 'guest'.
inactivity_timeout	NsSeconds	number	The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting. Unsigned 64-bit integer. Example: '1234'.
creation_time	NsTime	number	Time when this user was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
last_modified	NsTime	number	Time when this user was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
full_name	NsFullName	string	Fully qualified name of the user. Alphanumeric string of up to 64 chars, starts with letter, can include space, apostrophe('), hythen(-). Example: 'User-13 Peterson'.
email_addr	NsEmail	string	Email address of the user. Case insensitive email address. Example: bob@wikipedia.com.
disabled	NsBoolean	boolean	User is currently disabled. Possible values: 'true', 'false'.
last_login	NsTime	number	Last login time. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
last_logout	NsTime	number	Last logout time. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
logged_in	NsBoolean	boolean	User is currently logged in. Possible values: 'true', 'false'.

JSON Response