User Guide

178 Chapter 5: XML Results Reference
principal
Description
Contains information about a principal.
For general information about principals, see “About principals, SCOs, and IDs” on page 17.
Attributes
account-id
The ID of the account of which the principal is a member. This attribute is
returned only by the
principal-info API.
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 (Built-in) group; for more
information, see the
type attribute.
permission-id The permissions that the principal has for the specified SCO. This attribute is
returned only by the
permissions-info API.
principal-id The ID of the principal.
type The type of principal. Possible values include the following:
■ admins
■ authors
■ course-admins
■ dt-authors
■ dt-reviewers
■ event-admins
■ event-group
■ everyone
■ external-group
■ external-user
■ group
■ guest
■ hosted-admins
■ hosted-sales
■ hosted-support
■ learners
■ live-admins
■ seminar-admins
■ user
is-hidden Indicates whether a principal is hidden (true) or not (false).