Modify an access user.
/uam/acmUser/modifyAcmUser/{userName}
| URI parameters | |
|---|---|
| userName |
Account name.
String type. Required. No default value. The string cannot exceed 32 characters. |
<acmUser>
<fullName>hello001</fullName>
<certification>wangqiang001</certification>
<address>Beijing</address>
<phone>01088784567</phone>
<email>wangqiang@xxx.com</email>
<userGroupName>group-1.group-2</userGroupName>
<userAdditionalInfo>
<fieldName>age</fieldName>
<fieldValue>30</fieldValue>
</userAdditionalInfo>
<userAdditionalInfo>
<fieldName>school</fieldName>
<fieldValue>Beijing University</fieldValue>
</userAdditionalInfo>
<ifSelfModifyPsd>true</ifSelfModifyPsd>
<ifPsdPolicy>false</ifPsdPolicy>
<ifNeedChangeNext>false</ifNeedChangeNext>
<invalidTime>2011-12-30 12:30</invalidTime>
<idleTimeout>514</idleTimeout>
<onlineLimit>100</onlineLimit>
<ifSelfPay>true</ifSelfPay>
<promptInfo>hello</promptInfo>
<nasIp>1.1.1.1</nasIp>
<nasPort>1</nasPort>
<outerVlanId>1</outerVlanId>
<wlanSsid>wlanSsid</wlanSsid>
<innerVlanId>1</innerVlanId>
<innerVlanId>2</innerVlanId>
<computerName>computerName</computerName>
<imsiCode></imsiCode>
<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>
<imeiCode></imeiCode>
</acmUser>
| acmUser subelements | |
|---|---|
| fullName |
User name
String type. If the element does not exist, the value is not changed.
|
| certification |
Identity number
String type. If the element does not exist, the value is not changed.
|
| address |
Contact address
String type. If the element does not exist, the value is not changed.
|
| phone |
Telephone
String type. If the element does not exist, the value is not changed.
|
|
Email
String type. If the element does not exist, the value is not changed.
|
|
| userGroupName |
User group Name
String type. If the element does not exist, the value is not changed.
|
| userAdditionalInfo |
Additional information element
Element type. Optional. Multiple elements are supported. If the element does not exist, the value is not changed.
|
| userAdditionalInfo/fieldName |
Additional information name
String type.
|
| userAdditionalInfo/fieldValue |
Additional information value
String type.
|
| ifSelfModifyPsd |
Whether or not the access user can change the account password.
Boolean type. Optional. The value can be true or false. The default value is true. |
| ifPsdPolicy |
Whether or not to enable the password strategy.
Boolean type. Optional. The value can be true or false. The default value is false. The value is valid only when the Allow User to Change Password field of the user is set to Yes. |
| ifNeedChangeNext |
Whether or not to ask the user to change the password at next login.
Boolean type. Optional. The value can be true or false. The default value is false. Do not modify the default value. The value is valid only when password strategy is enabled for the user. |
| invalidTime |
Expiration date.
Date type. Optional. No default value. The value must be in the format of yyyy-MM-dd, later than the current date, and earlier than 2038-01-01. |
| idleTimeout |
Maximum idle time allowed for the access user.
Integer type. Optional. No default value. The value is in the range of 1 to 600 minutes. |
| onlineLimit |
Maximum number of concurrent logins allowed for the access user.
Integer type. Optional. No default value. Valid value range is 1 to 255. |
| ifSelfPay |
Whether or not the access can use the self-recharge service.
Boolean type. Optional. The value can be true or false. The default value is false. The value is valid only when the accounting component is installed. |
| promptInfo |
Login message.
String type. Optional. No default value. The string cannot exceed 60 characters. |
| nasIp |
Device IPv4 address.
String type. Optional. No default value. The value is valid IPv4 address in dotted decimal format, excluding 0.0.0.0 or 255.255.255.255. The string cannot exceed 15 characters. |
| nasPort |
Port through which the access device is connected to the user.
Integer type. Optional. No default value. Valid value range is 0 to 255. |
| outerVlanId |
Outer VLAN ID assigned to the user.
Long integer type. Optional. No default value. Valid value range is 1 to 4094. |
| wlanSsid |
SSID of the WLAN accessed by the user.
String type. Optional. No default value. The string cannot exceed 120 characters. |
| innerVlanId |
VLAN ID or inner VLAN ID assigned to the user.
Long integer type. Optional. No default value. Valid value range is 1 to 4090. You can specify at most 500 VLAN IDs/inner VLAN IDs. |
| computerName |
Computer name.
String type. Optional. No default value. The string cannot exceed 128 characters. |
| imsiCode |
IMSI code.
String type. Optional. No default value. The string cannot exceed 100 characters. |
| boundDomainName |
Domain bound to the user.
String type. Optional. No default value. The string cannot exceed 128 characters. |
| logonDomainName |
Domain to which the user was logged in.
String type. Optional. No default value. The string cannot exceed 128 characters. |
| ip |
User IPv4 address.
String type. Optional. No default value. The value is a valid IPv4 address in dotted decimal format, excluding 0.0.0.0 and 255.255.255.255. The string cannot exceed 15 characters. You can specify at most 1000 IPv4 addresses. |
| macAddress |
User MAC address.
String type. Optional. No default value. The string can contain at most 17 characters and must be a complete MAC address in the format of XX-XX-XX-XX-XX-XX, XX:XX:XX:XX:XX:XX, or XXXX-XXXX-XXXX. You can specify at most 1000 MAC addresses. |
| ipv6 |
User IPv6 address.
String type. Optional. No default value. The string cannot exceed 39 characters. You can specify at most 1000 IPv6 addresses. The value is valid only when the Enable IPv6 option is selected in the system parameter settings. |
| imeiCode |
IMEI code.
String type. Optional. No default value. The string cannot exceed 100 characters. |
| thirdConfId |
Third-party authentication configuration ID.
Integer type. Optional. No default value. Valid value range is 0 to 255. Enter this value to modify the user as a third-party authentication user. The value takes effect only when the third-party authentication is enabled.
|
| Error codes | |
|---|---|
| 60500 | The input parameter is empty. |
| 61311 | User group does not exist. |
| 62400 | Parameter "{0}" cannot be empty. |
| 62401 | The value of parameter "{0}" is invalid. |
| 62406 | You can specify at most "{1}" parameter "{0}". |
HTTP/1.1 204 No Content
Modify information about access user lzz01.
PUT http://inc_host:8080/imcrs/uam/acmUser/modifyAcmUser/lzz01 accept: application/xml ... <acmUser>
<fullName>hello001</fullName>
<certification>wangqiang001</certification>
<address>Beijing</address>
<phone>01088784567</phone>
<email>wangqiang@xxx.com</email>
<userGroupName>group-1.group-2</userGroupName>
<userAdditionalInfo>
<fieldName>age</fieldName>
<fieldValue>30</fieldValue>
</userAdditionalInfo>
<userAdditionalInfo>
<fieldName>school</fieldName>
<fieldValue>Beijing University</fieldValue>
</userAdditionalInfo>
<ifSelfModifyPsd>true</ifSelfModifyPsd>
<ifPsdPolicy>false</ifPsdPolicy>
<ifNeedChangeNext>false</ifNeedChangeNext>
<invalidTime>2011-12-30 12:30</invalidTime>
<idleTimeout>514</idleTimeout>
<onlineLimit>100</onlineLimit>
<ifSelfPay>true</ifSelfPay>
<promptInfo>hello</promptInfo>
<nasIp>1.1.1.1</nasIp>
<nasPort>1</nasPort>
<outerVlanId>1</outerVlanId>
<wlanSsid>wlanSsid</wlanSsid>
<innerVlanId>1</innerVlanId>
<innerVlanId>2</innerVlanId>
<computerName>computerName</computerName>
<imsiCode></imsiCode>
<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>
<imeiCode></imeiCode>
</acmUser>
HTTP/1.1 204 No Content