User Guide

120 Chapter 5: XML Results Reference
access-key (key)
There are two tags named access-key; they are described in different sections.
Description
A special access key for use in self-registration.
Attributes
None.
Contained tags
None (content only).
Returned by
accesskey-info
Example
<access-key>vb7gmg6ohtz4y7k6</access-key>
See also
access-key (container)
, access-keys
access-key-group
Description
Container tag; contains information about which group the user automatically joins by self-
registering using the special access key. Also contains a login and name tag.
Attributes
account-id
The ID of the account of which the principal is a member. This attribute is
returned only by the
principal-info action.
has-children Indicates whether the principal has children. Groups have children and users
don’t, so this attribute indicates whether the principal is a group.
is-primary Indicates whether the principal is a primary group; for more information, see the
type attribute.
principal-id The ID of the principal.
type The type of principal. Possible values include "user", "group", and various kinds of
primary groups:
"admins", "authors", "live-admins", and "course-admins". You can create
and modify users and groups, but not primary groups.
Contained tags
login, name
Returned by
accesskey-info