User Guide

74 Chapter 4: XML API Reference
</principal>
</principal-list>
</results>
See also
principal-info
, principal-update, principal-list-by-field, principals-delete.
principal-list-by-field
Availability
Breeze 5.
Description
Allows you to list principals that have a given field value.
Parameters
value
The field value on which you want to search.
Filters
The following table lists the fields on which the data can be filtered and sorted:
For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on
page 21.
Returned elements
principal-list
Sample results
<results>
<status code="ok" />
<principal-list>
<principal account-id="7" principal-id="10018" type="user" has-
children="false" is-primary="false" is-hidden="false">
<name>John Doe</name>
<login>[e-mail]</login>
<description>Example User</description>
Field Filter/Sort
account-id
Filter and sort
principal-id
Filter and sort
type
Filter and sort
has-children
Filter and sort
is-primary
Filter and sort
name
Filter and sort
login
Filter and sort
description
Filter and sort