Common Request Parameters
A set of common request parameters is required for each User Administration Service operation. The following table lists all of the User Administration Service common request parameters. For more information on the parameters, view the TIBCO LogLogic® Appliance user interface for Manage Users as well as the online help.
| Parameter | Description | Values | Required | Type |
|---|---|---|---|---|
| authToken |
Token string returned from the authentication service or the “username/password”. |
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 xxxx Remote 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 user’s 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 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. The Import/Export privilege contains a forward slash (/). To specify it here, replace / with %2F. |
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 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 currently listed in the appliance. However, devices created after a user is created is not included in the device list. To access all devices at all times, the user must have the Access all devices in the appliance privilege. deviceName - specify each device name as it appears in the 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 which user can access. |
Any valid IP address | yes
Applies to: |
number |
| changeLogin Name | New login name for a user.
If empty, the login name is unchanged. |
Any text up to 64 characters in length. | yes (for updateUser) | string |