Page tree
Skip to end of metadata
Go to start of metadata

Obtaining information about user hosts

You can easily list user-on-host pairs by sending the following HTTP request.

GET /api/v1/report/features/user-history/user-hosts/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&(additional parameters, as needed)

where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.

ParameterRequiredTypeDescription
${returnType}YesstringStandard format option. See Making an API request for details.
sdYesdateSpecifies the start date for which the report will be generated.
edYesdateSpecifies the end date for which the report will be generated.
standard report optionsNovarious

See Making an API request for details.

Response

On success, this report will contain one row for each user that used any license in the specified time range and each host on which the license was used. Each row consists of the following columns.


ColumnFull nameTypeDescriptionVisible by default in export
uidUser IDintegerInternal License Statistics identification of user that checked out licenses. Yes

un

UserstringName of the user that checked out licenses. Yes

hn

HoststringThe host where the user checked out licenses. Yes

uil

User is from LDAP

boolean

Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field.

Error (x) Unavailable

Note that the order in the table is the default order of the columns in the exported file.

 Example

The following example shows a command that downloads data in CSV format about user-on-host pairs that were using licenses for 2019-01-01 through 2019-01-14.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/features/user-history/user-hosts/csv?sd=2019-01-01&ed=2019-01-14"