Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

PUT userManagement/users

Updates an existing user. User name is used to identify the user to be edited

Since Product Version: 3.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

PUT

Resource URL

/webacs/api/v4/op/userManagement/users

Unmodified

This resource has not been modified since the previous API version.

Request Payload Parameters

Attribute Description

name String

Required

The name of the user.

Note that the name is used to identify the user to be edited and can not be changed.

password String

The password that will replace the current user password. Must be provided if you are changing the current password.

userGroups String[]

Required

is a member of

virtualDomains String[]

Virtual domains the user is a member of

wirelessUser boolean

Indicates if the user is a wireless user. If 'true' then user will see only wireless specific navigation menu items.

Not supported for root, Lobby Ambassador and mDNS Policy Admin users.

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Request Payload

https://172.20.127.108/webacs/api/v4/op/userManagement/users

<?xml version="1.0" ?>
<updateUserDTO>
  <name>String value</name>
  <password>String value</password>
  <userGroups>
    <userGroup>String value</userGroup>
    <userGroup>Another string value</userGroup>
  </userGroups>
  <virtualDomains>
    <virtualDomain>String value</virtualDomain>
    <virtualDomain>Another string value</virtualDomain>
  </virtualDomains>
  <wirelessUser>true</wirelessUser>
</updateUserDTO>

Sample JSON Request Payload

https://172.20.127.108/webacs/api/v4/op/userManagement/users.json

{
  "updateUserDTO" : {
    "name" : "String value",
    "password" : "String value",
    "userGroups" : {
      "userGroup" : [ "String value", "Another string value" ]
    },
    "virtualDomains" : {
      "virtualDomain" : [ "String value", "Another string value" ]
    },
    "wirelessUser" : true
  }
}