Read

GET v1/users

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
iSortBy	NsString
pageSize	NsUnsignedInt
id	NsObjectID
name	NsCliUserName
search_name	NsSearchName
description	NsDescription
role_id	NsObjectID
role	NsUserRoles
inactivity_timeout	NsSeconds
creation_time	NsTime
last_modified	NsTime
full_name	NsFullName
email_addr	NsEmail
disabled	NsBoolean
last_login	NsTime
last_logout	NsTime
logged_in	NsBoolean

GET v1/users/detail

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
iSortBy	NsString
fields	NsCommaSeparatedList
pageSize	NsUnsignedInt
id	NsObjectID
name	NsCliUserName
search_name	NsSearchName
description	NsDescription
role_id	NsObjectID
role	NsUserRoles
inactivity_timeout	NsSeconds
creation_time	NsTime
last_modified	NsTime
full_name	NsFullName
email_addr	NsEmail
disabled	NsBoolean
last_login	NsTime
last_logout	NsTime
logged_in	NsBoolean

GET v1/users/id

Query parameters

Parameter	Type
fields	NsCommaSeparatedList

Description

List one or more users.

Normal Response Codes

200 206

HTTP Error Codes

400 401 403 404 500 503

Detail Codes

SM_complex_type_query_param

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_start_row_beyond_end_row

SM_start_row_beyond_total_rows

SM_unexpected_query_param

SM_unsupported_query_operator

SM_version_name

Response

Parameter	Type	JSON Type	Description
id	NsObjectID	string	Identifier for the user. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
name	NsCliUserName	string	Name of the user. String of up to 32 alphanumeric characters, beginning with a letter, which matches the CLI requirements for a user name. Example: 'user1'.
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('), hyphen(-). 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

            

{
   "startRow" : 0,
   "totalRows" : 1,
   "endRow" : 1,
   "data" : [
      {
         "name" : "admin"
      }
   ]
}