Add an access user with specified information.
/uam/acmUser
<acmUser>
<fullName>hello001</fullName>
<certification>hello001</certification>
<address>beijing</address>
<phone>01088784567</phone>
<email>wangqiang@xxx.com</email>
<userGroupName>group-1.group-2.group-3</userGroupName>
<userAdditionalInfo>
<fieldName>age</fieldName>
<fieldValue>30</fieldValue>
</userAdditionalInfo>
<userAdditionalInfo>
<fieldName>school</fieldName>
<fieldValue>Beijing University</fieldValue>
</userAdditionalInfo>
<userName>hello</userName>
<userPassword>1</userPassword>
<ifSelfModifyPsd>true</ifSelfModifyPsd>
<ifPsdPolicy>false</ifPsdPolicy>
<ifNeedChangeNext>false</ifNeedChangeNext>
<invalidTime></invalidTime>
<idleTimeout>60</idleTimeout>
<onlineLimit>1</onlineLimit>
<feeType>2</feeType>
<cardPrepay>100</cardPrepay>
<ifSelfPay>true</ifSelfPay>
<promptInfo>hello</promptInfo>
<appliedService>
<serviceTemplateId>4</serviceTemplateId>
<userIp></userIp>
</appliedService>
<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. Required when the platform user ID is empty. Optional when the platform user ID is specified. No default value.
|
| certification |
Identity number
String type. Required when the platform user ID is empty. Optional when the platform user ID is specified. No default value.
|
| address |
Contact address
String type. Optional. No default value.
|
| phone |
Telephone
String type. Optional. No default value.
|
|
Email
String type. Optional. No default value.
|
|
| userGroupName |
User group Name
String type. Optional. No default value.
When the basic user information already exists and the attribute value is inconsistent with the name of the user group to which the basic user information belongs, the user group actually allocated is the user group to which the basic user information belongs.
|
| userAdditionalInfo |
Additional information element
Element type. Optional. Multiple elements are supported. If the element does not exist, the default value is used.
|
| userAdditionalInfo/fieldName |
Additional information name
String type.
|
| userAdditionalInfo/fieldValue |
Additional information value
String type.
|
| userName |
Account name of the access user.
String type. Required. No default value. The account name is a string of 1 to 32 characters. It cannot be computer or anonymous, and cannot contain tabs or any of the following special characters: # + / ? % & = * ' @ \ " [] ()`
|
| userPassword |
Password.
String type. Required. No default value. The string cannot exceed 32 characters.
|
| ifSelfModifyPsd |
Whether or not to allow the user to change the password.
Boolean type. Optional. The value can be true or false. The default value is true.
|
| ifPsdPolicy |
Whether or not to enable password strategy.
Boolean type. Optional. The value can be true or false. The default value is false. This value is valid only when the user is allowed to change the password.
|
| ifNeedChangeNext |
Whether or not to ask the user 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. In minutes. No default value. Valid value range is 1 to 600.
|
| onlineLimit |
Maximum number of concurrent logins allowed for the access user.
Integer type. Optional. The default value is 1. Valid value range is 1 to 255.
|
| feeType |
Account type.
Integer type. Optional. The default value is 2 (Postpaid). Valid values are: 2 (Prepaid) or 3 (Postpaid). Any value other than 3 is treated as 2. The value is valid only when the accounting component is installed.
|
| cardPrepay |
Prepaid amount.
BigDecimal type. Optional. The value can be an integer or decimal in the range of 0 to 1000000. The number of decimal digits must be within the range of local currency units of the system. The value is valid only when the accounting component is installed.
|
| ifSelfPay |
Whether or not self-recharge service is available for the access user account.
Boolean type. Optional. The default value is false. The value is valid only when the accounting component is installed.
|
| promptInfo |
User login message.
String type. Optional. No default value. The string cannot exceed 60 characters.
|
| appliedService |
Information about the service template assigned to the user.
Object type. Required. No default value. Each appliedService parameter must include the value of the serviceTemplateId attribute. If the service requires allocating IP addresses to access users, the userIp attribute must also be specified. For more information about the attributes, see "Query Services Assigned to User."
|
| nasIp |
IP address of the access device.
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 or inner VLAN IDs.
|
| computerName |
Name of the computer used by the user.
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 includes 1 to 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 |
IPv6 address of the user.
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.
|
| Error codes | |
|---|---|
| 60500 | The input parameter is empty. |
| 62400 | Parameter "{0}" cannot be empty. |
| 62401 | The value of parameter "{0}" is invalid. |
| 61020 | The user does not exist. |
| 62403 | The account name already exists. |
| 62406 | You can specify at most "{1}" parameter "{0}". |
| 62424 | No service is found with the service ID "{0}". |
| 62425 | The service with the ID "{0}" is unavailable. |
| 62426 | A service with the service suffix "{0}" is already assigned to the user. You cannot assign another service with the same suffix to the user. |
| 62428 | You must specify the IP address assigned to the access user for service "{0}". |
| 62429 | The number of decimal digits of "{0}" exceeds the upper limit. |
HTTP/1.1 201 Created Location: http://inc_host:8080/imcrs/uam/acmUser/hello
Add an access user named hello.
POST http://inc_host:8080/imcrs/uam/acmUser accept: application/xml Content-Type: application/xml; charset=UTF-8 ... <acmUser>
<fullName>hello001</fullName>
<certification>hello001</certification>
<address>beijing</address>
<phone>01088784567</phone>
<email>wangqiang@xxx.com</email>
<userGroupName>group-1.group-2.group-3</userGroupName>
<userAdditionalInfo>
<fieldName>age</fieldName>
<fieldValue>30</fieldValue>
</userAdditionalInfo>
<userAdditionalInfo>
<fieldName>school</fieldName>
<fieldValue>Beijing University</fieldValue>
</userAdditionalInfo>
<userName>hello</userName>
<userPassword>1</userPassword>
<ifSelfModifyPsd>true</ifSelfModifyPsd>
<ifPsdPolicy>false</ifPsdPolicy>
<ifNeedChangeNext>false</ifNeedChangeNext>
<invalidTime></invalidTime>
<idleTimeout>60</idleTimeout>
<onlineLimit>1</onlineLimit>
<feeType>2</feeType>
<cardPrepay>100</cardPrepay>
<ifSelfPay>true</ifSelfPay>
<promptInfo>hello</promptInfo>
<appliedService>
<serviceTemplateId>4</serviceTemplateId>
<userIp></userIp>
</appliedService>
<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 201 Created Location: http://inc_host:8080/imcrs/uam/acmUser/hello