Home » Web Services Implementation Guide

User Administration Service Operations

Submitted by Anonymous on Mon, 06/09/2008 - 16:38

User Administration Service Operations

The User Administration Service operations enable you to manage users in your LogLogic Appliance.

Overview

The User Administration Service operations enable you to create, read, update, and delete users in your system. In the LogLogic Appliance you can view the user interface implementation by navigating to Administration > Manage Users.

Implementation Guidelines

The following are general implementation guidelines for the User Administration Service operations:


  • A set of Common Request Parameters are required for each operation.
  • You must specify a value for all Required parameters.
  • You must specify the value of the Common Request Parameters only.
  • All parameters must be implemented in the order in which they appear in the Request Parameters section for each of the operations.
  • All values for Common Request Parameters must be enclosed by double quotation marks (“value”). If the name of a device or a parameter value includes a forward slash (/), such as HP/UX, or IBM i5/OS, you must replace the forward slash with %2F. (The F is case-sensitive.
    Examples: HP%2FUX or IBM i5%2FOS

User Administration Service Operation Descriptions

There are two kinds of operations:


  • local - operation is performed on the local Appliance itself
  • remote - operations (names ending with Remote) performed on a specified remote Appliance

The User Administration Service operation contains the following operations:

Status Codes

The Status Codes are:

2000 Server success
4000 Unauthorized request
5000 Invalid parameter, getStatusMessage() contains detail information about the error

Common Request Parameters

A set of Common Request Parameters are required for each User Administration Service operation. This table lists all of the User Administration Service Common Request Parameters. For more information on the parameters, view the LogLogic Appliance user interface for Manage Users as well as the online help.

Parameter Description Values Required Type
authToken Unique authentication token.   yes string
applianceIP The managed Appliance on which you perform the operation.
If the value is blank, it retrieves the Appliance IP address from the local Appliance.
This parameter is available only for Management Station Appliances using operations with Remote in the name.		 IP address of a managed Appliance. To specify an IP address, use the standard IP address format. For example:
10.1.2.3		 yes (for xxxxRemote operations only) string
loginName Login name for the user you are creating. Any text up to 16 characters in length. yes string
firstName First name of the user. Any text up to 64 characters in length. No string
lastName Last name of the user. Any text up to 64 characters in length. No string
loginPassword Password used for user login.
In addition, you can use the loginPassword parameter to update/change a users password.		 The password must be at least 6 characters long, contain at least one non-alphabetic character, and cannot be the same as the loginName. yes string
phone Contact phone number of user. Any valid phone number up to 32 characters in length. No string
email Email address of the user. Any valid email address up to 64 characters in length. Yes string
enabled Enable or disable the user specified with the loginName parameter.
(Appears as enabled or disabled in returned value.)		 Possible values:
yes -- enable
no -- disable		 yes string
privileges Identifies the access privileges for the specified user. You can specify a User Type (contains a pre-defined list of privileges) or specific privileges.
To view the user interface implementation, navigate to the Administration > Manage Users > Privileges tab. For a list of possible values, see User Administration Privileges.
 To specify multiple values, you must separate entries with a forward slash (/). For example:
User Administrator/Manage Alerts/Manage Devices		 yes string
devices Identifies the devices that the user can access. You can specify All for provide access to all devices in the Appliance or you can identify specific devices.
You can use the getList Operation for the Device Service Operations to retrieve a list of device names in your LogLogic Appliance. Alternatively, you can view use the user interface to view all devices by navigating to Administration > Manage Devices.		 Possible values:
All - all devices
deviceName - specify each device name as it appears in the LogLogic Appliance.
To specify multiple values, you must separate entries with a forward slash (/). For example:
“Device1/Device2/ Device7/Device9”		 yes string
appliances (Management Station only)
Identifies the Appliance in the Management Station cluster that this user accesses.		 Any valid IP address yes (for createUser, createUserRemote, updateUser and updateUserRemote only) number
changeLoginName New login name for a user.
If empty, the login name is unchanged.		 Any text up to 64 characters in length. yes (for updateUser and updateUserRemote only) string
0
Your rating: None

User login

Current Poll

What programming language are you using to communicate with the LogLogic API?:

Recent Comments