User Guide

accesskey-info 51
To c al l t h e accesskey-exec API, you need 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 an
interface to register for the meeting or course, creating a Breeze user account in the process. To
obtain the special access key, call
accesskey-info. This API automatically adds the self-
registering user to the self-registration group associated with the course or meeting, if the group
exists.
The difference between using
accesskey-exec and principal-update to create a new user is
that you can call
accesskey-exec without being logged in or being an administrator. Also, 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 API.
Parameters
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.
Returned elements
None.
Sample results
<results>
<status code="ok" />
</results>
accesskey-info
Availability
Breeze 4. This API is not supported in Breeze 5.
Note: The accesskey feature no longer exists in Breeze 5, so there is no updated API.
Description
Provides a special access key, if such a key is associated with the specified SCO. For more
information, see the
accesskey-exec API.