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

# GET userManagement/users

Returns list of users

Since Product Version: 3.2

- Jump To

- v1
- v2
- v3
- v4

### 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://10.64.88.203/webacs/api/v1/op/userManagement/users

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v1/op">
      <usersDTO>
        <active>true</active>
        <name>String value</name>
        <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>
      </usersDTO>
      <usersDTO>
        <active>false</active>
        <name>Another string value</name>
        <userGroups>
          <userGroup>String value</userGroup>
          <userGroup>Another string value</userGroup>
        </userGroups>
        <virtualDomains>
          <virtualDomain>String value</virtualDomain>
          <virtualDomain>Another string value</virtualDomain>
        </virtualDomains>
        <wirelessUser>false</wirelessUser>
      </usersDTO>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/userManagement/users",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
        "usersDTO" : [{
          "active" : true,
          "name" : "String value",
          "userGroups" : {
            "userGroup" : ["String value",
            "Another string value"]
          },
          "virtualDomains" : {
            "virtualDomain" : ["String value",
            "Another string value"]
          },
          "wirelessUser" : true
        },
        {
          "active" : false,
          "name" : "Another string value",
          "userGroups" : {
            "userGroup" : ["String value",
            "Another string value"]
          },
          "virtualDomains" : {
            "virtualDomain" : ["String value",
            "Another string value"]
          },
          "wirelessUser" : false
        }]
      }
    }

### 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

## Resource URL

/webacs/api/v2/op/userManagement/users

Unmodified

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

## 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://10.64.88.203/webacs/api/v2/op/userManagement/users

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
      <usersDTO>
        <active>true</active>
        <name>String value</name>
        <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>
      </usersDTO>
      <usersDTO>
        <active>false</active>
        <name>Another string value</name>
        <userGroups>
          <userGroup>String value</userGroup>
          <userGroup>Another string value</userGroup>
        </userGroups>
        <virtualDomains>
          <virtualDomain>String value</virtualDomain>
          <virtualDomain>Another string value</virtualDomain>
        </virtualDomains>
        <wirelessUser>false</wirelessUser>
      </usersDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/userManagement/users.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
        "usersDTO" : [ {
          "active" : true,
          "name" : "String value",
          "userGroups" : {
            "userGroup" : [ "String value", "Another string value" ]
          },
          "virtualDomains" : {
            "virtualDomain" : [ "String value", "Another string value" ]
          },
          "wirelessUser" : true
        }, {
          "active" : false,
          "name" : "Another string value",
          "userGroups" : {
            "userGroup" : [ "String value", "Another string value" ]
          },
          "virtualDomains" : {
            "virtualDomain" : [ "String value", "Another string value" ]
          },
          "wirelessUser" : false
        } ]
      }
    }

### 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

## Resource URL

/webacs/api/v3/op/userManagement/users

Unmodified

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

## 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://10.64.88.203/webacs/api/v3/op/userManagement/users

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v3/op">
      <usersDTO>
        <active>true</active>
        <name>String value</name>
        <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>
      </usersDTO>
      <usersDTO>
        <active>false</active>
        <name>Another string value</name>
        <userGroups>
          <userGroup>String value</userGroup>
          <userGroup>Another string value</userGroup>
        </userGroups>
        <virtualDomains>
          <virtualDomain>String value</virtualDomain>
          <virtualDomain>Another string value</virtualDomain>
        </virtualDomains>
        <wirelessUser>false</wirelessUser>
      </usersDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v3/op/userManagement/users.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
        "usersDTO" : [ {
          "active" : true,
          "name" : "String value",
          "userGroups" : {
            "userGroup" : [ "String value", "Another string value" ]
          },
          "virtualDomains" : {
            "virtualDomain" : [ "String value", "Another string value" ]
          },
          "wirelessUser" : true
        }, {
          "active" : false,
          "name" : "Another string value",
          "userGroups" : {
            "userGroup" : [ "String value", "Another string value" ]
          },
          "virtualDomains" : {
            "virtualDomain" : [ "String value", "Another string value" ]
          },
          "wirelessUser" : false
        } ]
      }
    }

### 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

## Resource URL

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

Unmodified

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

## 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://10.64.88.203/webacs/api/v4/op/userManagement/users

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
      <usersDTO>
        <active>true</active>
        <name>String value</name>
        <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>
      </usersDTO>
      <usersDTO>
        <active>false</active>
        <name>Another string value</name>
        <userGroups>
          <userGroup>String value</userGroup>
          <userGroup>Another string value</userGroup>
        </userGroups>
        <virtualDomains>
          <virtualDomain>String value</virtualDomain>
          <virtualDomain>Another string value</virtualDomain>
        </virtualDomains>
        <wirelessUser>false</wirelessUser>
      </usersDTO>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "usersDTO" : [ {
          "active" : true,
          "name" : "String value",
          "userGroups" : {
            "userGroup" : [ "String value", "Another string value" ]
          },
          "virtualDomains" : {
            "virtualDomain" : [ "String value", "Another string value" ]
          },
          "wirelessUser" : true
        }, {
          "active" : false,
          "name" : "Another string value",
          "userGroups" : {
            "userGroup" : [ "String value", "Another string value" ]
          },
          "virtualDomains" : {
            "virtualDomain" : [ "String value", "Another string value" ]
          },
          "wirelessUser" : false
        } ]
      }
    }