Access User View - Access User Management

Query Access User Details

Query detailed information about an access user.

Interface URI

/uam/acmUser/{userName}

Access Method

HTTP: GET
Parameters

Return Values

Status codes

200 (OK): Success.
204 (Gone): No data is found with the specified ID.
409 (Conflict): Failure.

Error codes

Error codes
62401	The value of parameter "{0}" is invalid.
62858	User "{0}" does not have an account.

Message header

HTTP/1.1 200 OK

Message body

<acmUser>
 <userId>1</userId>
 <userName>pre01</userName>
 <userGroupId>1</userGroupId>
 <serviceGroupName>Ungrouped</serviceGroupName>
 <platUserId>68</platUserId>
 <fullName>pre01</fullName>
 <certification>1</certification>
 <address></address>
 <phone></phone>
 <email></email>
 <blackState>false</blackState>
 <status>1</status>
 <ldapState>false</ldapState>
 <ifSelfModifyPsd>true</ifSelfModifyPsd>
 <ifPsdPolicy>false</ifPsdPolicy>
 <userCreateTime>2011-12-02</userCreateTime>
 <ifNeedChangeNext>false</ifNeedChangeNext>
 <lastUsingTime>2011-12-23 15:48</lastUsingTime>
 <invalidTime></invalidTime>
 <idleTimeout></idleTimeout>
 <onlineLimit>1</onlineLimit>
 <onlineState>false</onlineState>
 <promptInfo></promptInfo>
 <feeType>2</feeType>
 <currentBalance>30.00</currentBalance>
 <ifSelfPay>true</ifSelfPay>
 <appliedService>
  <serviceTemplateId>3</serviceTemplateId>
  serviceTemplateName>Disable IP Allocating</serviceTemplateName>
  <serviceSuffix>no</serviceSuffix>
  <feeStrategyId>1</feeStrategyId>
  <feeStrategyName>No Accounting</feeStrategyName>
  <curCycleStartTime></curCycleStartTime>
  <curCycleEndTime></curCycleEndTime>
 </appliedService>
  <serviceTemplateId>29</serviceTemplateId>
  <serviceTemplateName>Adaptive Continuous Deductions</serviceTemplateName>
  <serviceSuffix>zsy</serviceSuffix>
  <feeStrategyId>2</feeStrategyId>
  <feeStrategyName>baoyue</feeStrategyName>
  <curCycleStartTime></curCycleStartTime>
  <curCycleEndTime></curCycleEndTime>
 </appliedService>
 <appliedService>
  <serviceTemplateId>1</serviceTemplateId>
  <serviceTemplateName>Guest Service</serviceTemplateName>
  <serviceSuffix>sdfsadf</serviceSuffix>
  <feeStrategyId>3</feeStrategyId>
  <feeStrategyName>No Accounting</feeStrategyName>
  <curCycleStartTime></curCycleStartTime>
  <curCycleEndTime></curCycleEndTime>
 </appliedService>
 <nasIp></nasIp>
 <nasPort>1</nasPort>
 <outerVlanId>1</outerVlanId>
 <innerVlanId>1</innerVlanId>
 <innerVlanId>2</innerVlanId>
 <wlanSsid>wlanSsid</wlanSsid>
 <computerName>computerName</computerName>
 <boundDomainName>boundDomainName</boundDomainName>
 <logonDomainName>logonDomainName</logonDomainName>
 <ip>1.1.1.1</ip>
 <ip>1.1.1.2</ip>
 <macAddress>11:11:11:11:11:11</macAddress>
 <macAddress>11:11:11:11:11:12</macAddress>
 <ipv6>3FFE:FFFF:7654:FEDA:1245:BA98:3210:4562</ipv6>
 <ipv6>3FFE:FFFF:7654:FEDA:1245:BA98:3210:4563</ipv6>
 <ifManageGuest>0</ifManageGuest>
</acmUser>

Element description

acmUser subelements
userId	ID of the access user. Long integer type.
userName	Access user account name. String type.
userGroupId	User group ID. Long integer type.
userGroupName	User group name. String type.
platUserId	ID that uniquely identifies the platform user to which the uesr is attached. Long integer type.
fullName	User name. String type.
certification	Identity number. String type.
address	Contact address. String type.
phone	Cell phone number. String type.
email	Email address. String type.
blackState	Whether or not the user is blocked. Boolean type. The value can be true or false.
ldapState	Whether or not the user is an LDAP user. Boolean type. The value can be true or false.
userCreateTime	Date when the access user was created. Date type.
lastUsingTime	Time when the access user last logged off. Date type.
invalidTime	Expiration date. Date type. The access user expires and become invalid after the expiration date. An empty field indicates that the access user never expires.
idleTimeout	Maximum idle time allowed for the access user. Integer type. The access user is forcibly logged off when the idle timeout timer expires.
onlineLimit	Maximum concurrent logins. Integer type. This parameter specifies the upper limit of concurrent logins that the access user is allowed.
onlineState	Online state. Boolean type. The value can be true or false.
promptInfo	Login message. String type. Message delivered to the access user when the user passes authentication.
feeType	Account type. Integer type. 2: Prepaid. 3: Postpaid. This element is returned only when the accounting component is installed.
ifOwe	Whether the postpaid account has a negative balance. Boolean type. The value can be true or false. This element is returned only when the accounting component is installed.
currentBalance	Current balance. BigDecimal type. This element is returned only when the accounting component is installed.
status	Account state. Integer type. 1: Normal. 2: Cancelled. 3: Inactivated. 4: Suspended. 7: Trial. 8: Temporarily Cancelled.
ifSelfPay	Whether or not self-recharge service is available for the access user account. Boolean type. The value can be true or false. This element is returned only when the accounting component is installed.
appliedService	Information about the service assigned to the access user. Service applied the access user. For more information, see "Query Services Assigned to User."
nasIp	Device IP address. String type.
nasPort	Port through which the access device is connected to the user. Integer type.
outerVlanId	Outer VLAN ID assigned to the user. Long integer type.
innerVlanId	VLAN ID or inner VLAN ID assigned to the user. Long integer type.
wlanSsid	SSID of the WLAN accessed by the user. String type.
computerName	Computer name. String type.
boundDomainName	Domain bound to the user. String type. Domain bound to the user's computer.
logonDomainName	Domain to which the user was logged in. String type. Domain to which the user's computer logged on.
imsiCode	IMSI code. String type.
ip	User IPv4 address. String type.
macAddress	User MAC address. String type.
ipv6	User IPv6 address. String type. This element is returned only when the Enable IPv6 option is selected in the system parameter settings.
ifManageGuest	Guest manager type. Integer type. 0: Non-guest mnager. 1: Guest manager. 2: Super guest manager.
imeiCode	IMEI code. String type.

Example

Query detailed information about the user named pre01.

Request
Response