User Guide

accesskey-exec 41
Action reference entries
The following section lists the Breeze web service actions alphabetically.
accesskey-exec
Description
Executes special functions associated with special access keys.
Currently, letting users self-register for meetings and courses is the only supported special
function. The documentation for this action covers only the self-registration function.
To call this
accesskey-exec, you need the normal access key for the account and a special access
key associated with a meeting or course. Someone who isn’t a Breeze user can be given the special
access key and can then use a UI to register for the meeting or course, creating a Breeze user
account for themselves in the process.
To obtain the special access key, call the
accesskey-info action.
The difference between using
accesskey-exec to create a new user and using principal-
update
is that you can call accesskey-exec without being logged in or being an administrator.
This action automatically adds the self-registering user to the self-registration group associated
with the course or meeting, if the group exists. For more information, see
accesskey-info.
Additionally, you can specify custom fields for new users when you call
accesskey-exec. To do
so, pass the custom fields to
accesskey-exec as additional parameters in name and value pairs,
as shown in the following example:
field-id=xx&value=xxx&customfield-id=xx&value=xxx
The field-id parameters can be determined from the data returned by the custom-fields
action.
Parameters
accesskey
The access key for your account.
Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze version
4.1. If you include this parameter in Breeze 4.1, it is ignored.
access-key
The special access key that lets the user self-register.
first-name The new user’s first name.
has-children Always set this parameter to 0 when registering a new user.
last-name The new user’s last name.
login The new user’s login name, which is usually the user’s e-mail address.
password The new user’s password.
type Always set this parameter to "user" when registering a new user.
Filters
Results cannot be filtered or sorted.