Cisco Acano X-series 開発者ガイド

9 User Related Methods

Users are created by synchronizing against LDAP servers (as discussed

); however, there

are a number of methods for retrieving user information. This chapter covers:

n

n

n

9.1 Retrieving Users

GET method performed on the “/users” node.

Parameters

Type/Value

Description/Notes

filter

String

Supply filter=<string> in the URI to return just those users that match the
filter

offset
limit

Number
Number

An "offset" and "limit" can be supplied to retrieve elements other than the
first "page" in the notional list (see

tenantFilter

ID

Supply tenantFilter to return only those users associated with the specified
tenant

Response
elements

Type/Value

Description/Notes

Response is structured as a top-level <users total=”N”> tag with potentially
multiple <user> elements within it.

user id

userJid

ID

String

<user> elements follow the general form on the left.

For example,  first.last@example.com

tenant

ID

The id of the tenant with which this user is associated, if applicable

9.2 Retrieving Detailed Information on an Individual User

GET method performed on a “/users/<user ID>” node

If the user ID supplied is valid, a “200 OK” response is received, with XML content of the form:

Response elements

Type/Value

Description/Notes

user id

ID