The People API provides access to SkyVault people and groups.
- addAuthorityaddAuthority(parentGroup, authority) adds an authority (User or Group ) to the specified parent group.
- changePasswordchangePassword(oldpassword, newpassword) changes the password for the current user only when the old password is supplied.
- createGroupcreateGroup these methods are used to create groups.
- createPersoncreatePerson creates a person (cm:person) object.
- deleteGroupdeleteGroup(group) this method removes a group from the system.
- deletePersondeletePerson(username) deletes a person with the given user name from the system.
- disableAccountdiableAccount(userName) disables an enabled account. It can be invoked only by an Administrator authority.
- enableAccountenableAccount(userName) enables a disabled account. It can be invoked only by an Administrator authority.
- getCapabilitiesgetCapabilities(person) returns a hash of the specified user's capabilities.
- getContainerGroupsgetContainerGroups(person) gets the groups that contain the specified authority.
- getExcludeTenantFiltergetExcludeTenantFilter(person) returns a boolean.
- getGroupgetGroup(groupId) gets a group given its group ID.
- getImmutablePropertiesgetImmutableProperties(person) returns a map of the Person properties that are marked as immutable for the given user.
- getMembersgetMembers returns an array of people nodes belonging to the specified group (including all subgroups).
- getPeoplegetPeople() methods get the collection of people stored in the repository.
- getPeoplePaginggetPeoplePaging() method gets the collection of people stored in the repository.
- getPeopleEvaluationModeScriptNode getPeopleEvaluationMode(username) returns permission evaluation mode.
- getPersonScriptNode getPerson(username) returns a single (cm:person) node associated with the specified user name, or null if the person does not exist.
- getPersonFullNameScriptNode getPersonFullName(username) - Faster helper when the script just wants to build the Full name for a person. Avoids complete getProperties() retrieval for a cm:person.
- isAccountEnabledisAccountEnabled(userName) determines if the specified user's account is enabled.
- isAdminisAdmin(person) - determines if the specified user is an Administrator authority.
- isGuestisGuest(person) determines if the specified user is a Guest authority.
- removeAuthorityremoveAuthority(parentGroup, authority) removes an authority from a group.
- setPasswordsetPassword(userName, password) sets the password for the given user. It is only executable by an Administrator authority.
- setQuotasetQuota(person, quota) sets the quota content in bytes for the specified person. It can be invoked only by an Administrator authority.
Parent topic: Scripting API