Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET userManagement/users

Returns list of users

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

GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

/webacs/api/v1/op/userManagement/users

Response Parameters

Attribute Description

active boolean

Lock status of the user. True if the user is not locked

name String

The name of the user

userGroups String[]

Groups the user 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 Response Payload

https://localhost/webacs/api/v1/op/userManagement/users

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/userManagement/users" rootUrl="https://localhost/webacs/api/v1/op">
  <usersDTO>
    <active>true</active>
    <name>String value</name>
    <userGroups>
      <userGroup>String value</userGroup>
    </userGroups>
    <virtualDomains>
      <virtualDomain>String value</virtualDomain>
    </virtualDomains>
    <wirelessUser>true</wirelessUser>
  </usersDTO>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v1/op/userManagement/users.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/userManagement\/users",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
    "usersDTO" : {
      "active" : true,
      "name" : "String value",
      "userGroups" : {
        "userGroup" : "String value"
      },
      "virtualDomains" : {
        "virtualDomain" : "String value"
      },
      "wirelessUser" : true
    }
  }
}