User Guide

46 Chapter 4: XML API Reference
The following table lists the user management APIs supported in Breeze 5:
Alphabetical API listing
The following list contains all of the APIs that are documented in this reference chapter. APIs that
Breeze 5 does not support are indicated in the Description column.
API Description
group-membership-update Adds one or more principals to a group, or removes one or
more principals from a group.
principal-info Provides information about the specified principal. The
specified principal can be a user or a group.
principal-list Provides a complete list of users and groups, including
primary groups.
principal-list-by-field Allows you to list principals that have a given field value.
principal-update Updates information for a principal in the current account or
creates a new principal.
principals-delete Deletes one or more principals.
user-accounts Provides a list of the accounts to which the specified user
belongs.
user-update-pwd Changes a user’s password.
API Description
accesskey-exec Executes special functions associated with special access
keys. This API is not supported in Breeze 5.
accesskey-info Provides a special access key, if such a key is associated with
the specified SCO. This API is not supported in Breeze 5
acl-field-info Returns field-ids and values for an ACL.
acl-field-list Returns the list of acl-ids and values in the logged-in account
for the given field-id.
acl-field-update Updates the field value for the given ACL and field.
acl-preference-update Updates the user profile to the specified language and time
zone settings.
action-list Returns a list of Breeze web service APIs.
common-info Provides basic information about the current user and server.
custom-field-update Updates the specified account custom field. Creates a new
custom field if none exists. This API is not supported in
Breeze 5.
custom-fields Lists the custom fields of an account and the details of the
fields. This API is not supported in Breeze 5.
custom-fields-delete Deletes the specified account custom field.