User Guide

principal-update 75
</principal>
</principal-list>
</results>
See also
principal-info
, principal-list, principal-update, principals-delete
principal-update
Availability
Breeze 4.
Description
Updates information for a principal in the current account or creates a new principal. For
information about principals, see “About principals, SCOs, and IDs” on page 17.
In most cases, you must acquire the original version of the principal’s information (using
principal-info) before calling the principal-update API.
To create a new principal, call the
principal-update API without specifying a principal-id
parameter. If you create a new principal, the returned XML provides information about the new
principal, including the principal’s ID.
In Breeze 4, the
principal-update API allowed you to update custom fields. In Breeze 5, you
must call
acl-field-update to update fields.
Parameters
description
The new group’s description. Use only when creating a new group.
first-name The new first name to assign to the user. Use only when creating or updating a
user.
has-children Indicates whether the principal has children. If the principal is a group, set this
parameter to 1. If the principal is a user, set this parameter to 0.
last-name The new last name to assign to the user. Use only when creating or updating a user.
login The principal’s new login name, which is usually the principal’s e-mail address. This
parameter must be specified only when creating or updating a user.
name The new group’s name. Use only when creating a new group.
password The new user’s password. Use only when creating a new user.
principal-id The ID of the principal for which you are changing data. If you omit this
parameter, the
principal-update API creates a new principal.
type The type of the new principal. Use only when creating a new principal. For information
about the available types, see “About principals, SCOs, and IDs” on page 17.
Filters
Results cannot be filtered or sorted.