Query users, Interface uri, Access method – HP Intelligent Management Center Licenses User Manual

Page 178: Interface uri access method, Parameters

Advertising
background image

Query Users

Query users with certain criteria.

Interface URI

/user

Access Method

HTTP

GET

Parameters

Query parameters

userName

userName

String type, supporting wildcard characters. Optional. No default value.

Identity number.

certification

String type, supporting wildcard characters. Optional. No default value.

Contact address.

address

String type, supporting wildcard characters. Optional. No default value.

Telephone number.

phone

String type, supporting wildcard characters. Optional. No default value.

Email address

email

String type, supporting wildcard characters. Optional. No default value.

User group ID.

userGroupId

Long integer type. Optional. No default value.

Self-service account name.

ssName

String type. Optional. No default value.

Activate self-service account or not. 1 for active. 2 for inactive.

ssType

Integer type. Optional. No default value.

The position where the first returned record is located in the whole returned result.

start

Integer type. Optional. The default value is 0. If a negative value, the default value is used.

The total number of returned records.

size

Integer type. Optional. The default value is 10. If a negative value, the default value is used.

The sequencing field of the returned result set.

orderBy

String type. Optional. The default value is userName. Valid values include userName and id.

Whether or not the result is sequenced in reverse order.

desc

Boolean type. Optional. The default value is false. Only valid when the orderBy parameter is specified.

Only the number of records that meet the requirements is returned.

total

Boolean type. Optional. The default value is false. When the value is true, the start and size attributes
are invalid, the returned message body is empty, and the Total attribute of the message header
returns the number of records that meet the requirements.

178

User Management

Advertising