Raritan Computer CC-WSAPI-0B-v5.1.0-E Marine Radio User Manual


 
Chapter 2: API Definitions
19
Integer passwordExpirationPeriod The user will have to reset
their password after this many days (required if
passwordExpirationEnabled is true). This value will always be
clear if this feature is disabled.
boolean forcePasswordChange - When true, the user will have to
change their password on the next login. When the user is first
added with addUser(), forcePasswordChange will be forced to
true. The value of forcePasswordChange can be modified with
editUser().
String fullName The user’s full name to be used when
generating reports and notifications to more easily identify the
user. (optional)
String emailAddress (optional)
String phoneNumber (optional)
String groups[ ] An array of the name(s) of the group(s) to
which this user is a member. These are the groups from which
this user's permissions will be assigned.
UserManagementException
Exception returned for all errors specific to user management.
Services
getUser
Returns configuration data for the specified user.
parameters
String sessionID
String userName - The login name of the desired user.
return value
CCSGUser - The requested user.
getAllUsers
Returns an array containing the CCSGUser data for each user defined
on the CC-SG.
parameters
String sessionID
return value
CCSGUser []